Update README
This commit is contained in:
parent
a676cf5440
commit
88bfebb251
16
README.md
16
README.md
|
@ -1,3 +1,19 @@
|
|||
# pblog
|
||||
|
||||
Pandoc static blog generator
|
||||
|
||||
[https://pblog.xyz](https://pblog.xyz)
|
||||
|
||||
## Getting Started
|
||||
|
||||
You can always read through the up-to-date article: [Introducing pblog](https://pblog.xyz/blog/pblog-intro.html)
|
||||
|
||||
But very basic steps:
|
||||
|
||||
1. Install dependencies
|
||||
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!
|
||||
|
|
|
@ -7,7 +7,7 @@ TITLE="pblog.xyz"
|
|||
DESCRIPTION="Pandoc static blog generator"
|
||||
COPYRIGHT="Copyright 2022, Bradley Taunt"
|
||||
AUTHOR="hello@tdarb.org (Bradley Taunt)"
|
||||
OS="Linux" # "Linux" for Linux, "BSD" for BSD Systems (including MacOS)
|
||||
OS="BSD" # "Linux" for Linux, "BSD" for BSD Systems (including MacOS)
|
||||
HTML_LANG="en_US" # Your document (HTML) language setting
|
||||
|
||||
# Blog structure settings (most users should use these defaults)
|
||||
|
|
Loading…
Reference in New Issue