web.myco.systems/README.md

47 lines
1.6 KiB
Markdown
Raw Normal View History

2023-07-31 03:07:41 +00:00
# web.myco.systems
### Start developing with the site
MycoSystems client site
2023-09-02 01:55:59 +00:00
2023-09-08 18:37:05 +00:00
```
git clone https://git.myco.systems/mycosystems/web.myco.systems.git
```
```
2024-04-19 16:00:43 -04:00
git fetch
```
```
git switch rework
```
```
2023-09-08 18:37:05 +00:00
git submodule update --init --recursive
```
Optionally we recommend installing prettier, the prettierrc file is already preconfigured to use the go template plugin.
```
npm install --save-dev prettier prettier-plugin-go-template
```
2023-09-08 18:37:05 +00:00
### Writing articles
- [ ] Grammar checked
- [ ] Spelling checked
- [ ] Title fits the article
- [ ] folder name is short and fits the title
- [ ] 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.
```
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.
2023-09-02 01:55:59 +00:00
# License:
2024-04-16 21:48:08 -04:00
[MIT](https://git.myco.systems/mycosystems/web.myco.systems/src/branch/main/LICENSE), thank you to the people over at [Blowfish](https://blowfish.page)