stamdStatic Markdown Page Generator |
| git clone git://git.dimitrijedobrota.com/stamd.git |
| Log | Files | Refs | README | LICENSE | HACKING | CONTRIBUTING | CODE_OF_CONDUCT | BUILDING |
README.md (1617B)
0 # stamd 1 2 Static Markdown blogging platform that generates everything you need 3 4 ## Description 5 6 With this project you can seamlessly turn a collection of .md files into a 7 static webpage, with auto generated indexes for categories, rss and atom feeds, 8 sitemap.xml and robots.txt. 9 10 It's configured to make pages for my [personal website](https://dimitrijedobrota.com/), 11 but as generation code is self documenting , it can be easily adopted to fit 12 your needs, all you have to do is change write_header and write_footer methods 13 as you see fit. 14 15 As of now most of the heavy lifting is done by md4c library, until I find time 16 to develop sophisticated Markdown to HTML converter. 17 18 19 ## Dependencies 20 21 * CMake 3.14 or latter 22 * Compiler with C++20 support (tested: clang 16.0.5, gcc 13.2.0) 23 * [Poafloc latest](https://github.com/DimitrijeDobrota/poafloc) 24 * [Hemplate latest](https://github.com/DimitrijeDobrota/hemplate) 25 * [md4c](https://github.com/mity/md4c) 26 27 28 ## Building and installing 29 30 See the [BUILDING](BUILDING.md) document. 31 32 33 ## Usage 34 35 > Please reference [cabin-deploy.sh](https://github.com/DimitrijeDobrota/cabin) for relevant usage example 36 37 38 ## Version History 39 40 - 0.3 41 * Generate sitemap.xml and robots.txt 42 * Generate rss.xml and atom.txt feeds 43 * Configurable links 44 * Category indexes 45 - 0.2 46 * C++ rewrite 47 * Improved stability 48 * Improve readability 49 50 - 0.1 51 * Quick and dirty proof of concept written in C 52 53 54 ## Contributing 55 56 See the [CONTRIBUTING](CONTRIBUTING.md) document. 57 58 59 # Licensing 60 61 This project is licensed under the MIT License 62 - see the [LICENSE](LICENSE.md) document for details