Skip to content

Commit

Permalink
Fixes #142.
Browse files Browse the repository at this point in the history
  • Loading branch information
moorepants committed Apr 10, 2024
1 parent e9e4f4d commit 9e55eda
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@ Editing Guide
- Binary Assets such as images, videos, etc should be served from an external
hosting site. The information for pushing binary objects to the Dreamhost
DreamObject bucket is in the Fietslab Commons Google Drive. Do not commit
binary assets to this repository. Images should be all lower case unique
filenames with a ``-`` to separate words, for example:
binary assets to this Github repository. Images should be all lower case
unique filenames with a ``-`` to separate words, for example:
``my-image-for-this-blog-post.png``. All assets are store in the same
directory on the object store and should have unique file names.

Expand All @@ -34,15 +34,16 @@ Building Locally
It is good practice to build the documentation locally so that you can review
change before submitting a pull request.

First, clone the plugin repository::
First, clone the Pelican plugin repository::

$ git clone [email protected]:getpelican/pelican-plugins.git

Note the path to the plugin repository, e.g.::

/home/my_username/.../pelican-plugins

Clone the theme repository (you want the mechmotum branch to be active)::
Clone the theme repository (you want the mechmotum branch to be active because
we have custom edits on the theme)::

$ git clone -b mechmotum [email protected]:mechmotum/pelican-alchemy.git

Expand All @@ -64,7 +65,7 @@ THEME_PATH)::

Create a conda environment with pelican and the other needed dependencies::

$ conda create -f env.yml
$ conda env create -f env.yml
$ conda activate bikelab-website

Now you can build and serve the documentation with::
Expand Down

0 comments on commit 9e55eda

Please sign in to comment.