Write blog posts quickly using this little script. Originally based on Lichen, it is backwards compatible with Gemtext formatting.
On debian you can install the necessary Python dependencies (watchdog) with the ./install.sh bash script.
To write a post named example-post, make a file posts/example-post.md, write your stuff in there, then call python3 build.py example-post. The script is build to stay active and automatically recompile whenever it detects a change inside posts/example-post.md.
Below are examples for each of the features.
You may also check at posts/test.md and the resulting html file in results/test/index.html to see how it looks in practice.
- Bold text:
Wrap the text with a star (*). Example: *this text will be bold* - Italic text:
Wrap the text with two underscores (__). Example: __this text will be italic__ - Strikethrough text:
Wrap the text with two tildes (~~). Example: ~~this text will be strikethoughd~~
# Title## Big header### Smaller header
- Inline code/monospace font:
Wrap the text with two ticks (`). Example: `this will be monospace`. - Code blocks/monospace blocks:
Wrap the text with three ticks *in new lines* to start the code block.
Make sure the lines with the ticks does not contain any text.
Example:
```
this is a code block!
```
How to make an unordered list:
* Make a list
* Like this
* One list element per line
* Add a star for each element in the list
How to make an ordered list:
*) Make a list
*) Like this
*) One list element per line
*) Add a star and a closing parenthesis for each element in the list
How to add an image:
With no text below:
-> path/to/your/image.png | This is some alt text
With text below:
-> path/to/your/image.png | This is some alt text | Optionally, you can add visible text below the image
To make a block quote, add a new line and start it with "> " (don't forget the space). Anything after will be part of the quote.
> This is a very serious quote.
Links are similar looking to images, so be careful to not confuse between them!
=> https://zombo.com You can do anything at Zombo.com
% If you write a line starting with "%" like this, a little bird will show up next to your gorgeous text.
To add an horizontal bar to break off your paragraphs,
you can add a line consisting of three consecutive dashes ("---")
Like so:
---
Now, this text is separated and alone.
<>
<!-- anything between the <> is raw HTML. -->
<p style="color: red;">Hello!</p>
<>
- https://hackerbirds.neocities.org/Slightly-Less-Worse-HTML/
- https://hackerbirds.neocities.org/new-redesign/
You are meant to manually modify the code and resulting HTML to your liking if needed.
We will not maintain or modify this project for anyone else but us. That said, if you think you can use it or modify it for yourself, go ahead.