Add contribution instructions
This commit is contained in:
parent
d61f2eb7c8
commit
4f7225e886
13
README.md
13
README.md
|
@ -4,16 +4,11 @@ Pandoc static blog generator
|
||||||
|
|
||||||
[https://pblog.xyz](https://pblog.xyz)
|
[https://pblog.xyz](https://pblog.xyz)
|
||||||
|
|
||||||
## Getting Started
|
## Getting Started with Contributing
|
||||||
|
|
||||||
You can always read through the up-to-date article: [Introducing pblog](https://pblog.xyz/blog/pblog-intro.html)
|
To contribute to the blog, just create a new md file in /posts. You can copy the meta info from other posts.
|
||||||
|
|
||||||
But very basic steps:
|
This uses standard markdown, not any adaptation of it.
|
||||||
|
|
||||||
1. Install dependencies
|
For media, use 0.vern.cc, our 0x0 instance. We do not wipe old images on it so that isn't an issue.
|
||||||
2. Write posts in the `posts` directory
|
|
||||||
3. Write pages in the `pages` directory
|
|
||||||
4. Build the site
|
|
||||||
5. Upload your `_output` folder to your web host
|
|
||||||
|
|
||||||
Enjoy!
|
|
||||||
|
|
Loading…
Reference in New Issue