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