{"repo":"anirudhRowjee/saaru","free":true,"listed":false,"github":"https://github.com/anirudhRowjee/saaru","clone":"git clone https://github.com/anirudhRowjee/saaru.git","description":"Saaru is a static site generator written in Rust","language":"Rust","stars":36,"topics":["markdown","rust","static-site-generator"],"license":null,"category":"docs-static-sites","readme_excerpt":"Saaru Saaru is an opinonated Static Site Generator written in Rust. It uses Markdown and Jinja to render pure HTML/CSS Websites from your markdown + jinja source. Usage Running the program is simple. Once you have the repository cloned, you can use the following command to check oout the example site - Feel free to base your site off of the docs directory, which already has a bunch of templates pre-defined for you. It's got my name in there, but TODO Refactor soon enough. If nothing's wrong, your entire site as HTML and CSS will present itself in the ./docs/build directory. From then onwards, all you need to do is launch a web server with ./docs/build as the source such as this package. As of right now, Saaru is a little opinioniated on how exactly you should structure your site. As of right now, it boils down to having a folder with the following structure = It's possible to have an abitrary configuration of files in the src folder, so long as you've got each and every markdown document with the right frontmatter. Here's the absolute minimum frontmatter. (This will be iterated on, but as of now - ) There must be A MINIMUM OF ONE TAG PER POST . Live Reload As of right now, Live reload is enabled by default, and is hidden behind a command line flag. As and when you make a change to a file and save the file, Saaru will re-render that file into the build directory. On your browser (or if your web server supports watching the file system, do nothing - ), hit refresh to see your c","default_branch":null,"files":null,"tree":[],"storefront":"/r/anirudhRowjee","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/anirudhRowjee/saaru/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}