|
1 |
| -# very_good_docs_site |
| 1 | +# Very Good Docs Site |
2 | 2 |
|
| 3 | +[![Very Good Ventures][logo_white]][very_good_ventures_link_dark] |
| 4 | + |
| 5 | +Developed with 💙 by [Very Good Ventures][very_good_ventures_link] 🦄 |
| 6 | + |
| 7 | +[![License: MIT][license_badge]][license_link] |
3 | 8 | [](https://github.com/felangel/mason)
|
4 | 9 |
|
5 |
| -A Very Good documentation site created by Very Good Ventures. |
| 10 | +A Very Good documentation site template powered by [Docusaurus][docusaurus_link] created by Very Good Ventures 🦄. |
6 | 11 |
|
7 |
| -_Generated by [mason][1] 🧱_ |
| 12 | +## What's Included ✨ |
8 | 13 |
|
9 |
| -## Getting Started 🚀 |
| 14 | +- ✅ GitHub Workflow |
| 15 | +- ✅ Pull Request Template |
| 16 | +- ✅ Issue Templates |
| 17 | +- ✅ Dependabot Integration |
| 18 | +- ✅ Light/Dark Mode |
| 19 | +- ✅ Landing Page |
| 20 | +- ✅ Docs powered by Markdown |
| 21 | +- ✅ Customizable Theming |
| 22 | +- ✅ MIT License |
10 | 23 |
|
11 |
| -This is a starting point for a new brick. |
12 |
| -A few resources to get you started if this is your first brick template: |
| 24 | +## Output 📦 |
13 | 25 |
|
14 |
| -- [Official Mason Documentation][2] |
15 |
| -- [Code generation with Mason Blog][3] |
16 |
| -- [Very Good Livestream: Felix Angelov Demos Mason][4] |
| 26 | +```sh |
| 27 | +├── .eslintrc.js |
| 28 | +├── .github |
| 29 | +│ ├── ISSUE_TEMPLATE |
| 30 | +│ │ ├── bug_report.md |
| 31 | +│ │ ├── build.md |
| 32 | +│ │ ├── chore.md |
| 33 | +│ │ ├── ci.md |
| 34 | +│ │ ├── config.yml |
| 35 | +│ │ ├── documentation.md |
| 36 | +│ │ ├── feature_request.md |
| 37 | +│ │ ├── performance.md |
| 38 | +│ │ ├── refactor.md |
| 39 | +│ │ ├── revert.md |
| 40 | +│ │ ├── style.md |
| 41 | +│ │ └── test.md |
| 42 | +│ ├── PULL_REQUEST_TEMPLATE.md |
| 43 | +│ ├── dependabot.yml |
| 44 | +│ └── workflows |
| 45 | +│ └── main.yaml |
| 46 | +├── .gitignore |
| 47 | +├── .prettierignore |
| 48 | +├── .prettierrc |
| 49 | +├── README.md |
| 50 | +├── babel.config.js |
| 51 | +├── docs |
| 52 | +│ └── overview.md |
| 53 | +├── docusaurus.config.js |
| 54 | +├── package.json |
| 55 | +├── sidebars.js |
| 56 | +├── src |
| 57 | +│ ├── css |
| 58 | +│ │ └── custom.css |
| 59 | +│ └── pages |
| 60 | +│ ├── index.module.css |
| 61 | +│ └── index.tsx |
| 62 | +├── static |
| 63 | +│ ├── .nojekyll |
| 64 | +│ └── img |
| 65 | +│ ├── hero.svg |
| 66 | +│ ├── hero_dark.svg |
| 67 | +│ ├── logo.svg |
| 68 | +│ ├── pillar1.svg |
| 69 | +│ ├── pillar2.svg |
| 70 | +│ └── pillar3.svg |
| 71 | +├── tsconfig.json |
| 72 | +└── yarn.lock |
| 73 | +``` |
17 | 74 |
|
18 |
| -[1]: https://github.com/felangel/mason |
19 |
| -[2]: https://github.com/felangel/mason/tree/master/packages/mason_cli#readme |
20 |
| -[3]: https://verygood.ventures/blog/code-generation-with-mason |
21 |
| -[4]: https://youtu.be/G4PTjA6tpTU |
| 75 | +[docusaurus_link]: https://docusaurus.io |
| 76 | +[license_badge]: https://img.shields.io/badge/license-MIT-blue.svg |
| 77 | +[license_link]: https://opensource.org/licenses/MIT |
| 78 | +[logo_white]: https://raw.githubusercontent.com/VGVentures/very_good_brand/main/styles/README/vgv_logo_white.png#gh-dark-mode-only |
| 79 | +[very_good_ventures_link_dark]: https://verygood.ventures#gh-dark-mode-only |
| 80 | +[very_good_ventures_link]: https://verygood.ventures |
0 commit comments