#Edit this partial

Help cuttlebelle development

Cuttlebelle can always use help in whatever form you can provide. Even if you just found a bug or find something difficult to understand on this website, file an issue in either of the repositories.

  1. Cuttlebelle issues
  2. Website issues

If you are curious as to whats next for Cuttlebelle or want to see how the progress is going, visit the Cuttlebelle board

#Edit this partial

Help plugin development

So far Cuttlebelle is going to implement a plugin system so that you can run your own code/logic when building your sites.

Plugins could be things like:

  • Multiple layouts
  • Sitemap generator
  • Service worker generator
  • etc

Other things that have been planned is a search engine. Because Cuttlebelles content is all in markdown and yaml files, its straight forward to index those files and provide an API for front end searches. Watch this space.

#Edit this partial

Help gui development

Cuttlebelles design is at heart of progressive enhancements. Even if you strip all the code away, you still have readable markdown files that can be used elsewhere. Cuttlebelle makes websites out of them. Now the next step is to add a GUI on top of Cuttlebelle that will make it easy for you to add partials and fill in its props.

The proposal so far:

┌─────────────────────┐                                                                                                                    
│      Authoring      │                                                                                                                    
└─────────────────────┴────────────────────────────────────────────────────────────────────────────────────────────────────────────────────

                         │                             │                         │                              │                          
  1. Authenticate               2. Select/add branch         3. Select/add file        4. Change file               5. Select reviewer     
                         │                             │                         │                              │                          
 ┌──────────────────┐          ┌──────────────────┐                                   ┌─────────┬───────────┐      ┌──────────────────┐    
 │                  │    │     │                ▼ │    │      ▢ = = = = =       │    │ ┌──┐    │ = = = = = │   │  │                ▼ │    
 └──────────────────┘          └─┬──────────────┬─┘           ▢ = = =                │ └──┘    │ = = = = = │      └─┬──────────────┬─┘    
 ┌──────────────────┐    │       │              │      │      ▣  = = = =        │    │ ┌──────┐│ = = = =   │   │    │              │      
 │•••••             │            │              │             ▢  = =                 │ └──────┘│ = = =     │        │              │      
 └──────────────────┘    │       │              │      │      ▣   = = =         │    │ ┌──────┐│ = = = = = │   │    │              │      
              ┌─────┐            │              │             ▢ = = =                │ │      ││ = = = = = │        │              │      
              │  >  │    │       │              │      │      ▢   = = = =       │    │ └──────┘│ = =       │   │    │              │      
              └─────┘            │              │             ▢ ═ ═                  │      ┌─┐│           │        │              │      
                         │       └──────────────┘      │                         │    │      └─┘│           │   │    └──────────────┘      
                                                                                      └─────────┴───────────┘                              
                         │                             │                         │                              │                          

                                                                   ▲                            ▲                                          
                                                                   │                            │                                          
                                                                   │                            │                                          
                                                                   │                            │                                          
                                                                   │                            │                                          
                                                                   └────────────────────────────┘                                          
┌─────────────────────┐                                                                                  
│      Approving      │                                                                                    
└─────────────────────┴──────────────────────────────────────────────────────────────────────────────────

                         │                             │                              │                    
  1. Authenticate           2. Select pending reviews       4. See changes                  5. Approve     
                         │                             │                              │                    
 ┌──────────────────┐         ┌──────────────────┐         ┌─────────────────────┐          ┌─────┐  
 │                  │    │    │                ▼ │     │   │ +  ═ ═ ═ ═ ═ ═ ═ ═  │    │     │  >  │      
 └──────────────────┘         └─┬──────────────┬─┘         │ +  ═ ═ ═ ═ ═ ═ ═ ═  │          └─────┘   
 ┌──────────────────┐    │      │              │       │   │ -  ═ ═ ═ ═ ═ ═ ═    │    │                 
 │•••••             │           │              │           │ -  ═ ═ ═ ═          │                        
 └──────────────────┘    │      │              │       │   │ +  ═ ═              │    │                  
              ┌─────┐           │              │           │ -  ═ ═ ═ ═ ═ ═ ═ ═  │                       
              │  >  │    │      │              │       │   │ *  ═ ═ ═ ═ ═        │    │                   
              └─────┘           │              │           └─────────────────────┘                      
                         │      └──────────────┘       │                              │                  

                         │                             │                              │                    

┌─────────────────────┐                                              
│     Publishing      │                                                
└─────────────────────┴────────────────────────────────────────────────

                         │                             │               
  1. Authenticate             4. See all changes           5. Approve  
                         │    since last merge         │               
 ┌──────────────────┐        ┌─────────────────────┐       ┌─────┐
 │                  │    │   │ +  ═ ═ ═ ═ ═ ═ ═ ═  │   │   │  >  │    
 └──────────────────┘        │ +  ═ ═ ═ ═ ═ ═ ═ ═  │       └─────┘  
 ┌──────────────────┐    │   │ -  ═ ═ ═ ═ ═ ═ ═    │   │            
 │•••••             │        │ -  ═ ═ ═ ═          │                  
 └──────────────────┘    │   │ +  ═ ═              │   │             
              ┌─────┐        │ -  ═ ═ ═ ═ ═ ═ ═ ═  │                 
              │  >  │    │   │ *  ═ ═ ═ ═ ═        │   │              
              └─────┘        └─────────────────────┘                
                         │                             │               

                         │                             │               

┌─────────────────────┐                                                                                                                    
│  Details of editor  │                                                                                                                    
└─────────────────────┴────────────────────────────────────────────────────────────────────────────────────────────────────────────────────

      ┌──────────────────────────────────────────────────────────────┬──────────────────────────────────────────────────────────────┐      
      │                       Editor                                 │                              Preview                         │      
      │                                                              │                                                              │      
      │    ┌───┐ ┌─────────────────────────────────────────────┐     │              Λ                                               │      
      │    │ + │ │                                          ▼  │     │             ╱ ╲                   .───────.                  │      
      │    └───┘ └─────────────────────────────────────────────┘     │            ╱   ╲                ,'         `.                │      
      │                                                              │           ╱     ╲             ,'             `.              │      
      │                                                              │          ╱       ╲           ;                 :             │      
      │    ┌──────────────────────────────────────┐                  │         ╱         ╲          │                 │             │      
      │    │                                      │                  │        ╱           ╲         │                 │             │      
      │    └──────────────────────────────────────┘                  │       ╱             ╲        :                 ;             │      
      │                                                              │      ╱               ╲        ╲               ╱              │      
      │    ┌───────────────────────────────────────────────────┐     │     ╱                 ╲        `.           ,'               │      
      │    │                                                   │     │    ╱                   ╲         `.       ,'                 │      
      │    └───────────────────────────────────────────────────┘     │   ▕                     ▏          `─────'                   │      
      │                                                              │    ╲                   ╱                                     │      
      │    ┌───────┬───────┬────┬───────┬───────┬───────┬──────┐     │     ╲                 ╱                                      │      
      │    │       │       │    │       │       │       │      │     │      ╲               ╱                                       │      
      │    ├───────┴───────┴────┴───────┴───────┴───────┴──────┤     │       ╲             ╱                                        │      
      │    │                                                   │     │        ╲           ╱                                         │      
      │    │                                                   │     │         ╲         ╱                                          │      
      │    │                                                   │     │          ╲       ╱                                           │      
      │    │                                                   │     │           ╲     ╱                                            │      
      │    │                                                   │     │            ╲   ╱                                             │      
      │    │                                                   │     │             ╲ ╱                                              │      
      │    │                                                   │     │              V                                               │      
      │    │                                                   │     │                                                              │      
      │    │                                                   │     │                                                              │      
      │    └───────────────────────────────────────────────────┘     │     ┌───────────────────────────────────────────────────┐    │      
      │                                                              │     │                                                   │    │      
      │                                                              │     │                                                   │    │      
      │    ┌───┐ ┌─────────────────────────────────────────────┐     │     │                                                   │    │      
      │    │ + │ │                                          ▼  │     │     │                                                   │    │      
      │    └───┘ └─────────────────────────────────────────────┘     │     └───────────────────────────────────────────────────┘    │      
      │                                                              │                                                              │      
      └──────────────────────────────────────────────────────────────┴──────────────────────────────────────────────────────────────┘      
┌─────────────────────┐                                                                                                                    
│   Details of diff   │                                                                                                                    
└─────────────────────┴────────────────────────────────────────────────────────────────────────────────────────────────────────────────────

      ┌──────────────────────────────────────────────────────────────┬──────────────────────────────────────────────────────────────┐      
      │                       Before                                 │                               After                          │      
      │                                                              │                                                              │      
      │               Λ                                              │                                                              │      
      │              ╱ ╲                   .───────.                 │              Λ                                               │      
      │             ╱   ╲                ,'         `.               │             ╱ ╲                    .─────.                   │      
      │            ╱     ╲             ,'             `.             │            ╱   ╲                  ╱       ╲                  │      
      │           ╱       ╲           ;                 :            │           ╱     ╲                ╱         ╲                 │      
      │          ╱         ╲          │                 │            │          ╱       ╲              ;           :                │      
      │         ╱           ╲         │                 │            │         ╱         ╲             │           │                │      
      │        ╱             ╲        :                 ;            │        ╱           ╲            │           │                │      
      │       ╱               ╲        ╲               ╱             │       ╱             ╲           :           ;                │      
      │      ╱                 ╲        `.           ,'              │      ╱               ╲           ╲         ╱                 │      
      │     ╱                   ╲         `.       ,'                │     ╱                 ╲           ╲       ╱                  │      
      │    ▕                     ▏          `─────'                  │    ▕                   ▏           ╲     ╱                   │      
      │     ╲                   ╱                                    │     ╲                 ╱             `───'                    │      
      │      ╲                 ╱                                     │      ╲               ╱                                       │      
      │       ╲               ╱                                      │       ╲             ╱                                        │      
      │        ╲             ╱                                       │        ╲           ╱                                         │      
      │         ╲           ╱                                        │         ╲         ╱                                          │      
      │          ╲         ╱                                         │          ╲       ╱                                           │      
      │           ╲       ╱                                          │           ╲     ╱                                            │      
      │            ╲     ╱                                           │            ╲   ╱                                             │      
      │             ╲   ╱                                            │             ╲ ╱                                              │      
      │              ╲ ╱                                             │              V                                               │      
      │               V                                              │                                                              │      
      │                                                              │                                                              │      
      │                                                              │                                                              │      
      │      ┌───────────────────────────────────────────────────┐   │     ┌───────────────────────────────────────────────────┐    │      
      │      │                                                   │   │     │                                                   │    │      
      │      │                                                   │   │     │                                                   │    │      
      │      │                                                   │   │     │                                                   │    │      
      │      │                                                   │   │     │                                                   │    │      
      │      └───────────────────────────────────────────────────┘   │     └───────────────────────────────────────────────────┘    │      
      │                                                              │                                                              │      
      └──────────────────────────────────────────────────────────────┴──────────────────────────────────────────────────────────────┘