web.myco.systems/README.md
brooke 7eb41f9fff
All checks were successful
Hugo / build (push) Successful in 26s
Update README.md
2024-04-28 23:28:32 +00:00

1.4 KiB

web.myco.systems

Start developing

git clone https://git.myco.systems/mycosystems/web.myco.systems.git
git fetch
git switch rework
git submodule update --init --recursive

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

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 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

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.

License:

MIT, thank you to the people over at Blowfish