Skip to content

Commit

Permalink
Add instructions for new posts.
Browse files Browse the repository at this point in the history
  • Loading branch information
ben-madley-mt committed Oct 14, 2024
1 parent 9e99fa2 commit ab64604
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,23 @@ In the terminal:
- Install all the dependencies by running `npm install`
- Run `npm start`

## Adding a new post

To add a new post, follow the guidance provided by the [Design History Project](https://x-govuk.github.io/govuk-design-history/get-started/#document).

### Converting from Google Doc
If you want to convert a post from a Google Doc to be in the Design History:

1. `File -> Download -> Markdown (.md)`
2. Create a new file in the `posts` folder with front matter as detailed in the guidance, and copy and paste the download. Remove everything after the text of the post finishes. This is defining any images as data. Running locally, you should be able to see the new post, without images.
3. Edit the markdown to fix the layout. This will particularly involve changing bold text into headings, at the correct level.
4. `File -> Download -> Web page (.html, zipped)`
5. Open the zip file and copy the `images` from the images folder, into a new folder in the `app/images` directory, with the same name as the blog post (without the `.md`).
6. In the file for the post, search for `![][image`, and replace each image with a [normal markdown image](https://www.markdownguide.org/basic-syntax/#images-1) (this will involve swapping the second set square brackets for normal brackets). The remaining square brackets should contain your alt text, and the round brackets should contain a file path that looks like `/<name of the post>/<file name>`, e.g. `![Here is the alt text](/2024-08-22-2-service-blueprinting/image2.png)`
7. Check that all the images display properly in the post.
8. Commit the new files to the repository and push.


## Support & Technical notes

For guidance on the design history [see this website](https://x-govuk.github.io/govuk-design-history/get-started/).
Expand Down

0 comments on commit ab64604

Please sign in to comment.