Quick Start

To setup a new project:

  1. Install mspa ;
    # From source, requires cargo (ensure that ~/.cargo/bin is in $PATH)
    $ cargo install --git https://codeberg.org/jpistre/MarkdownSPA.git --tag 0.2
    
    # Or download the precompiled binary (linux only)
    $ curl -L -o mspa https://codeberg.org/jpistre/MarkdownSPA/releases/download/0.2/mspa-x86_64-unknown-linux-gnu
    
  2. Create a new project with mspa new [path (optionnal)] ;
  3. Start developping !
    # One-off build
    $ mspa build [path (optionnal)]
     
    # Start a livereload server
    $ mspa watch [path (optionnal)]
    

Here is the default configuration for all projects:

KeyDefault valueDescription
prod_url<empty>Base URL of your website
build_pathgeneratedWhere to generate all files
pages_pathpagesRoot of all markdown files
assets_pathassetsRoot of all static files (images, css, js, …)
templates_pathtemplatesRoot of all templates
defaults<object>Meta files default values