d3mon
/
wordpusher
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
Push the writing stack.
8 Commits 1 Branch 0 Tags 30 KiB
Shell 100%
Go to file
Gender Demon f850eff6ff Make it possible to run wordpusher from outside of its directory 2023-07-27 12:02:11 +00:00
.gitignore render_file: allow page elements to be customised 2021-09-04 20:37:34 +01:00
LICENCE Add LICENCE and README 2021-01-01 17:25:09 +00:00
README.md Rename: README to README.md so it formats correctly on git forges 2021-07-23 15:13:23 +01:00
render_file Make it possible to run wordpusher from outside of its directory 2023-07-27 12:02:11 +00:00
render_tree Make it possible to run wordpusher from outside of its directory 2023-07-27 12:02:11 +00:00

README.md

Wordpusher

Push the writing stack.

Quick start

  1. git clone https://tildegit.org/c-ren/wordpusher.git
  2. mkdir input
  3. mkdir output
  4. echo 'Hello world!' > input/index.md
  5. wordpusher/render_tree input output

You will want to edit render_file to change things that only apply to my deployment (the header that says "cren's website", for example). (Yes, I know that this is terrible practice. I will fix it.)

Usage

render_file

render_file is a POSIX sh script that mostly consists of running cmark on a file.

render_file <input.md>

render_tree

render_tree is another sh script that calls render_file on every file in a directory, including every file in every directory in that directory (it's recursive). You must also provide an output directory.

render_tree <input_dir> <output_dir>

Licence

Made available under the 0BSD licence, a permissive open-source licence. See the included LICENCE file for full text.