Skip to main content

FolderCMS

An easy CMS for managing your website using markdown files placed in folders.

CodeQL WorkflowGitHub tag (latest by dateGitHub licenseGitHub issuesGitHub last commitGitHub All releases downloadsGitHub repo sizeGitHub code size in bytes

Github Repo

But why ?​

Well, I didn't really find a suitable solution for my website needs. Automad was great, but lacked some flexibility I wanted to have like :

  • Drop-down menus in navbar
  • Easily make custom themes
  • Upload markdown files in sub-folders in a site-map like fashion
  • ... (more to come during doc phase)

This project aims to make those tasks a bit easier.

Wiki​

Everything you need start working with FolderCMS should be explained in the wiki.

Development plans​

  • Make a prototype
  • Polish the prototype to create a working demo
  • Create a Docker container
  • Release v1.0
  • Work on feature requests :)

You can look at the Project page for this repo to see what's going on.

How to install​

See How to install on wiki for more detailed information.

Dependencies​

  • NPM
git clone https://github.com/fred-corp/folderCMS

cd folderCMS

mkdir website

The last command creates a website folder at the root of folderCMS, in which you should add your webpages following the correct directory convention (wiki link to come). You can find example websites in the website-examples folder.

Run with Node.JS​

npm install

node server.js

Note : Alternatively, you can use npm ci to install dependencies from the lock file.

npm ci

node server.js

Run with Docker​

docker build . -t foldercms

Then, run the container with linked port 3000, linked directory website and linked directory config :

docker run -d -p 3000:3000 -v /path/to/website:/app/website -v --name FolderCMS-site foldercms

How to use​

See How to use on wiki.

Todo​

  • Work on issues (You can look at the Project page for this repo to see what's going on).
  • Create more themes
  • Test the files folder
  • Create live demo website
  • Write better documentation

Contributing​

Contributions are welcome !
Just fork the repo, make your changes and open a pull request.

License & Acknowledgements​

Made with ❤️, lots of ☕️, and lack of 🛌

Published under CreativeCommons BY-SA 4.0

Creative Commons License
This work is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.