kbenestad/mdcms
1
0
Fork 0
mirror of https://github.com/kbenestad/mdcms.git synced 2026-06-18 15:24:32 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update README.md

Browse source
This commit is contained in:
capthailand 2026-05-09 12:29:43 +07:00
parent ffb9a04934
commit 1657228b47
1 changed files with 2 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
README.md
View file

@ -1,6 +1,6 @@
# MD-CMS # 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. 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 ## Installation
1) Download the latest [release](https://github.com/kbenestad/mdcms/releases). 1) Download the latest [release](https://github.com/kbenestad/mdcms/releases) for your
- 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.
--- ---
## How it works ## How it works