|
1 | | -# Website |
| 1 | +# gh-templates Documentation |
2 | 2 |
|
3 | | -This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator. |
| 3 | +Welcome to the documentation for **gh-templates**—your command-line companion for scaffolding GitHub templates with ease. |
4 | 4 |
|
5 | | -## Installation |
| 5 | +This documentation explains how to use `gh-templates` to quickly add and manage templates for issues, pull requests, licenses, and `.gitignore` files in your repositories. Whether you're starting a new project or standardizing existing ones, these docs will guide you through installation, usage, and customization. |
6 | 6 |
|
7 | | -```bash |
8 | | -yarn |
9 | | -``` |
10 | | - |
11 | | -## Local Development |
12 | | - |
13 | | -```bash |
14 | | -yarn start |
15 | | -``` |
| 7 | +## About gh-templates |
16 | 8 |
|
17 | | -This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server. |
| 9 | +`gh-templates` streamlines the process of adding professional templates to your GitHub repositories. With a single command, you can: |
18 | 10 |
|
19 | | -## Build |
| 11 | +- Add structured **issue templates** for better bug reports and feature requests |
| 12 | +- Create standardized **pull request templates** to improve code review workflows |
| 13 | +- Add popular **license templates** to your projects |
| 14 | +- Generate language-specific **.gitignore** files to keep your repos clean |
20 | 15 |
|
21 | | -```bash |
22 | | -yarn build |
23 | | -``` |
24 | | - |
25 | | -This command generates static content into the `build` directory and can be served using any static contents hosting service. |
| 16 | +## Using the Documentation |
26 | 17 |
|
27 | | -## Deployment |
| 18 | +- **Getting Started**: Learn how to install and set up `gh-templates` |
| 19 | +- **Usage Guides**: Step-by-step instructions for each template type |
| 20 | +- **Customization**: Tips for customizing templates and output locations |
| 21 | +- **Reference**: Detailed command and option documentation |
28 | 22 |
|
29 | | -Using SSH: |
| 23 | +You can view and edit this documentation locally: |
30 | 24 |
|
31 | 25 | ```bash |
32 | | -USE_SSH=true yarn deploy |
| 26 | +yarn |
| 27 | +yarn start |
33 | 28 | ``` |
34 | 29 |
|
35 | | -Not using SSH: |
| 30 | +To build a static version for deployment: |
36 | 31 |
|
37 | 32 | ```bash |
38 | | -GIT_USER=<Your GitHub username> yarn deploy |
| 33 | +yarn build |
39 | 34 | ``` |
40 | 35 |
|
41 | | -If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch. |
| 36 | +For deployment instructions and more, see the additional guides in this directory. |
| 37 | + |
| 38 | +Ready to scaffold your GitHub templates? Start with the [Introduction](./intro.md) or jump to the [Installation Guide](./installation.md). |
0 commit comments