mdcms/docs/quickstart.md

MD-CMS — Quickstart

A lightweight Markdown-based CMS. Content is written as plain Markdown with YAML frontmatter; configuration lives in website/config.yml; navigation and search are generated by mdcms.py.

First run

1. Put content into website/pages/ and website/posts/.
2. Edit website/config.yml with your site name and preferences.
3. From this directory, run python3 mdcms.py.
4. In the menu, pick option 7 to register the website path (point it at the website/ folder).
5. Pick option 3 to build nav.yml and search.json.
6. Pick option 8 to start a local webserver and preview the site.

File layout

mdcms.py
quickstart.md
website/
  assets/
    fonts/
    images/
  pages/
    home.md
  posts/
  index.html
  config.yml
  nav.yml       (generated)
  search.json   (generated)

Licence

Apache 2.0. See docs.benestad.net for documentation.