diff --git a/README.md b/README.md index 15cc8e7..307b308 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # MD-CMS -> Markdown-based static site publishing — no server, no database, no terminal required. +> Markdown-based static site publishing MD-CMS lets you write and publish a website entirely in markdown. Drop your `.md` files in a folder, run the build tool, upload the output to any static host, and you're done. All rendering happens in the browser. @@ -8,16 +8,7 @@ MD-CMS lets you write and publish a website entirely in markdown. Drop your `.md ## Installation -1) Download the latest [release](https://github.com/kbenestad/mdcms/releases). - - The contents of `mdcms-vNNN.zip` and `mdcms.zip` are identical. Choose whatever suits your preference. -3) Unzip the content in your project directory. -3) Make necessary changes to `config.yml` and add pages to `pages/`. *Please note: Links to other pages are in the form `pages/pagename.md`.* -4) Open the terminal in your project directory, and: - - Open MDCMS.py with `python3 mdcms.py`. - - Select option 3 to generate a `nav.yml` and `search.json` file. - - Open `nav.yml` in your text editor and make sure that the section and title names are correct. - - Once you're satisfied, you're ready to upload the content of `website/`. If you need a ZIP file, return to the terminal and select option 1. - +1) Download the latest [release](https://github.com/kbenestad/mdcms/releases) for your --- ## How it works