mirror of
https://github.com/nairobilug/pelican-alchemy.git
synced 2024-12-30 12:15:06 +01:00
Add setup instructions
This commit is contained in:
parent
6247e58114
commit
a1157bf46e
1 changed files with 28 additions and 1 deletions
29
README.md
29
README.md
|
|
@ -1,3 +1,30 @@
|
|||
# pelican-alchemy
|
||||
|
||||
Demo!
|
||||
pelican-alchemy demo website!
|
||||
|
||||
## Fork / Clone the repo
|
||||
|
||||
If you haven't already, clone this repo (or your version of it), and:
|
||||
|
||||
$ git submodule init
|
||||
$ git submodule update
|
||||
|
||||
## Install Pelican & friends
|
||||
|
||||
Use `pip` to install the list of dependencies (including Pelican) into your virtual environment:
|
||||
|
||||
$ pip install -r requirements.txt
|
||||
|
||||
## Generate the website
|
||||
|
||||
Now that the dependencies exists, we can build:
|
||||
|
||||
$ make html
|
||||
|
||||
This takes the Markdown files from the `content/` directory and generates static HTML pages inside the `output/` directory.
|
||||
|
||||
## Preview the website
|
||||
|
||||
You can serve the generated site so it can be previewed in your browser:
|
||||
|
||||
$ make serve
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue