Skip to content

Remove references to blogs in README.md #195

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
finnlewis merged 1 commit into from
Jul 3, 2023
Merged

Remove references to blogs in README.md #195

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 1 addition & 20 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,26 +12,7 @@ The repository for the documentation sitting at https://docs.localgovdrupal.org/

4. `lando yarn dev` to start a dev server

## Blog

`*.md` files within `src/blog` will be parsed to generate blog posts which are listed at http://localgovdrupal.org/blog. Blog markdown files are required to have the following front matter.

```yml
---
title: "Example title"
description: "An example description."
date: "2021-01-18" (yyyy-mm-dd)
author: "J. Smith"
author_url: "#" (optional)
cannonicalUrl: "" (optional - for blog posts present on other sites)
---
```

Posts will be displayed on the listing page in reverse chronological order based on the `date` key within the front matter.
The author can be linked to a website or a twitter account in order to give credit to the author.
Please add a cannonical URL if the blog post exists originally on another website as well. [Google article on this topic](https://developers.google.com/search/docs/advanced/crawling/consolidate-duplicate-urls)

## Adding images to posts
## Adding images

You can add your images to the `images` folder next to the other folders and then you can reference these by using `![Alt text here](~@images/image.png)`.

Expand Down