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

Add installation section to README

Browse source 
Added installation instructions for MD-CMS.
This commit is contained in:
Kristian Benestad 2026-04-21 10:29:23 +07:00 committed by GitHub
parent 9aa3610df4
commit 7907a23980
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 14 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -6,6 +6,20 @@ 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.
---
## How it works
MD-CMS has two parts: