mycosystems/web.myco.systems
3
0
Fork 0
Code Issues Pull requests Activity Actions

Update README.md
All checks were successful
Hugo / build (push) Successful in 26s
Details

Browse source
This commit is contained in:
brooke 2024-04-28 23:28:32 +00:00
parent c7991495e4
commit 7eb41f9fff
1 changed files with 3 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
README.md
View file

@ -1,8 +1,6 @@
# web.myco.systems
### Start developing with the site
MycoSystems client site
### Start developing
```
git clone https://git.myco.systems/mycosystems/web.myco.systems.git
@ -17,7 +15,7 @@ git switch rework
git submodule update --init --recursive
```
Optionally we recommend installing prettier, the prettierrc file is already preconfigured to use the go template plugin.
Optionally we recommend installing prettier, the prettierrc file is preconfigured to use the go template plugin.
```
npm install --save-dev prettier prettier-plugin-go-template
@ -32,8 +30,7 @@ npm install --save-dev prettier prettier-plugin-go-template
- [ ] Lead and description are populated and fit the article
#### New Articles
When starting a new article or page use the command `hugo new content`
This will create a new folder and markdown file with frontmatter for a title and description, under the frontmatter is a lead. The lead is to substitue the description as the description is only used for opengraph, the lead will display right under the title when a user is reading that page or article.
When starting a new article or page, use the command `hugo new content` This will create a new folder and markdown file with frontmatter for a title and description; under the frontmatter is a lead. The lead is to substitute the description; as the description is only used for OG, the lead will display under the title when a user is reading that article.
```
hugo new content content/new-page/index.md
```
@ -41,7 +38,5 @@ hugo new content content/new-page/index.md
#### Editing/Reviewing Articles
When reviewing, an article should have a fitting title, the folder should match the name of the article (The folder decides the name of the articles's slug), and there should be a description and lead that are fitting to the article.
Other than that make sure to check off the basics, grammar, spelling, and split up run-on sentences.
# License:
[MIT](https://git.myco.systems/mycosystems/web.myco.systems/src/branch/main/LICENSE), thank you to the people over at [Blowfish](https://blowfish.page)