Write

Writing Trip Reports

First pull the repo so you're up to date. Navigate to the directory then:

git pull

Then add your write your trip report as a markdown file (.md extenstion) to the content/ folder. If its a standard post or trip report stick it in the content/articles/ folder. Try to keep to the placename-yyyy-mm-dd.md filename format where possible.

File layout

There is a template.md file in the root of the repo. Copy and paste this and fill it according to the instructions within. If in doubt have a look at an existing article. Make sure to use your nice editor with utf-8 and lf line breaks.

The key points are:

• There is a set of metadata at the top of each file. Make sure to fill this out
• Below the metadata, write your report
• Markdown syntax is simple and available online. Look it up, or look at another article to format yours. Also check this
• HTML works fine in markdown files (the same as they would in an html file) so if you can't do something with markdown just stick the html in.

Write the report! Check the wiki for information on how to fill out the metadata and use tags on the page.

Git it!

Save your .md file. Track the file in git:

git add path/to/file

Commit your file(s):

git commit -m "Put descriptive message here"

Please put in a good descirption of what you have done. E.g "Added a trip report for Yorkshire 3 15/03/15". Finally push your changes:

git push

And that can be it. Contact whoever is in charge of the site to let them know to update it. Or you can build it yourself

Local testing

If you want to see it yourself (good to check for formatting errors) then you can run the test script:

sh test.sh

This will generate the site "locally". Change to the output directory and start the webserver of your choice. I suggest:

python3 -m http.server

Navigate to 0.0.0.0:8000 with your web browser to see it. It is likely that images won't show up.