Very Good Docs Site

Developed with 💙 by Very Good Ventures 🦄

A Very Good documentation site template powered by Docusaurus created by Very Good Ventures 🦄.

What's Included ✨

• ✅ GitHub Workflow
• ✅ Pull Request Template
• ✅ Issue Templates
• ✅ Dependabot Integration
• ✅ Light/Dark Mode
• ✅ Landing Page
• ✅ Docs powered by Markdown
• ✅ Customizable Theming
• ✅ MIT License

Output 📦

├── .eslintrc.js
├── .github
│   ├── ISSUE_TEMPLATE
│   │   ├── bug_report.md
│   │   ├── build.md
│   │   ├── chore.md
│   │   ├── ci.md
│   │   ├── config.yml
│   │   ├── documentation.md
│   │   ├── feature_request.md
│   │   ├── performance.md
│   │   ├── refactor.md
│   │   ├── revert.md
│   │   ├── style.md
│   │   └── test.md
│   ├── PULL_REQUEST_TEMPLATE.md
│   ├── dependabot.yml
│   └── workflows
│       └── main.yaml
├── .gitignore
├── .prettierignore
├── .prettierrc
├── README.md
├── babel.config.js
├── docs
│   └── overview.md
├── docusaurus.config.js
├── package.json
├── sidebars.js
├── src
│   ├── css
│   │   └── custom.css
│   └── pages
│       ├── index.module.css
│       └── index.tsx
├── static
│   ├── .nojekyll
│   └── img
│       ├── hero.svg
│       ├── hero_dark.svg
│       ├── logo.svg
│       ├── pillar1.svg
│       ├── pillar2.svg
│       └── pillar3.svg
├── tsconfig.json
└── yarn.lock

Setup 🧑‍💻

Ensure you have the mason_cli installed.

# 🎯 Activate from https://pub.dev
dart pub global activate mason_cli

# 🍺 Or install from https://brew.sh
brew tap felangel/mason
brew install mason

Installation ☁️

# Install locally
mason add very_good_docs_site

# Install globally
mason add -g very_good_docs_site

Usage 🚀

mason make very_good_docs_site

Variables ✨

Hooks 🪝

• ❌   Pre-Gen
• ❌   Post-Gen

Environment 🌎

mason: ">=0.1.0-dev.52 <0.1.0"

0.0.3

• chore: migrate very_good_docs_site (#6)
• chore: update bricks to Mason 0.1.0-dev.52 (#28)

0.0.2

• build(deps-dev): bump @tsconfig/docusaurus in /src/very_good_docs_site (#135)
• chore: generate template (#136)
• build(deps): bump @docusaurus/core in /src/very_good_docs_site (#140)
• build(deps): bump @docusaurus/preset-classic in /src/very_good_docs_site (#137)
• build(deps): bump actions/setup-node from 3 to 4 (#145)
• chore: request code ownership (#147)
• feat: update to docusaurs 3.0 (#152)
• refactor: remove generator script (#162)

0.0.1+7

• build(deps): various dependency updates

0.0.1+6

• build(deps): various dependency updates

0.0.1+5

• build(deps): various dependency updates

0.0.1+4

• build(deps): various dependency updates

0.0.1+3

• build(deps): upgrade to docusaurus 2.2.0

0.0.1+2

• refactor: use npm

0.0.1+1

• build(deps): upgrade lockfile

0.0.1

• feat: initial release 🎉

MIT License

Copyright (c) 2022 Very Good Ventures

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.