Introduction •
Local Installation •
How to add a blog post •
This project is for the legal innovation lab wales developer page. The site includes:
- Blogs
- Documentation
- Projects
- Guides for workflows
The website is currently live at developer.legaltech.wales
The core technologies used for this project are:
- Ruby (2.7.3) (we recommend using rbenv for managing Ruby versions)
- Jekyll
Follow these instuctions for local installation:
Install Gems
bundle install
jekyll s
You should now be able to view the main web page at
http://localhost:4000
You might need to manually install Jekyll and Bundler on your system with:
gem install bundler jekyll
Further information about jekyll can be found here
###Local
To add a blog post locally, your post must be formatted in either markdown or html.
Navigate to the local blog folder and create a user & year if it doesn't already exist. Next, add your .html or .md file to the folder.
Make sure the file is formatted to the correct standard so it can be rendered properly. Look at the other existing blogs for examples of how to format or lookup the guides for markdown / html.
The start of the file will need to include some yaml "front matter" at the top of the file, such as this:
---
layout: blog
author: Alex # This links to your image and your blog posts subfolder
full-name: Alex W
category: One Day Build # Optional. Provides smaller header on card, and if "Our Approach" also adds article to home page
short-title: agile # This is the url title of your post
full-title: Agile Working # Title on the card on the homepage
sub-title: (during the pandemic) # Optional: adds subtitle to card on homepage
file-type: html
publish-date: January 20
publish-year: 2021
card-color: green
---
Finally, you will need to copy the same yaml information and add it to blogposts.yml
file under dev-page/_data
. The /_data
file is used to generate the blog index on the home page.
Once you have checked your post works on your local site and you have checked you can navigate to it. Then you can submit a pull request to this repository. The post will be then be reviewed.