-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
47 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,19 +1,56 @@ | ||
<h1 align="center"> | ||
<a href="https://github.com" target="_blank"> | ||
<img src="https://user-images.githubusercontent.com/99746865/197290616-f014aafd-466a-4564-922a-fbba06234173.png" width="64" height="64" alt="GitHub invertocat logomark" /> | ||
</a> | ||
</h1> | ||
|
||
<div align="center"> | ||
<img width="100%" src="https://github.com/primer/doctocat-nextjs/assets/10632534/22582519-ff8e-4e43-bf3d-95da35fe159b" alt="A 3D head illustration of Mona the Octocat, featuring a light source shining on her head and Mona being presented in the traditional Primer blue color hue. Mona is smiling."> | ||
<h1>Doctocat (Next.js)</h1> | ||
<p> | ||
A Next.js theme for building documentation sites | ||
</p> | ||
</div> | ||
|
||
<h1 align="center">Doctocat (Next.js)</h1> | ||
<div align="center"> | ||
<img width="100%" src="https://github.com/primer/doctocat-nextjs/assets/13340707/3458d024-cedc-4225-a86e-7b995a47e8c2" alt="A 3D head illustration of Mona the Octocat, featuring a light source shining on her head and Mona being presented in the traditional Primer blue color hue. Mona is smiling." /> | ||
<br /> | ||
<br /> | ||
|
||
<a href="https://github.com/primer/doctocat-nextjs/issues/new?assignees=&labels=bug&template=01_BUG_REPORT.md&title=bug%3A+">Report a Bug</a> | ||
· | ||
<a href="https://github.com/primer/doctocat-nextjs/issues/new?assignees=&labels=enhancement&template=02_FEATURE_REQUEST.md&title=feat%3A+">Request a Feature</a> | ||
· | ||
<a href="https://primer/doctocat-nextjs/discussions">Ask a Question</a> | ||
|
||
</div> | ||
|
||
<div align="center"> | ||
<br /> | ||
|
||
![Made with ❤️ by GitHub's Primer team](https://img.shields.io/badge/Made%20with%20%E2%9D%A4%EF%B8%8F%20by-GitHub's%20Primer%20team-blue?style=flat-square) | ||
[![PRs welcome](https://img.shields.io/badge/PRs-welcome-ff69b4.svg?style=flat-square)](https://github.com/primer/doctocat-nextjs) | ||
|
||
</div> | ||
|
||
## About | ||
|
||
Doctocat makes it easy to set up a documentation site on the Next.js framework, so that you can focus on what's important: writing docs. | ||
|
||
This project is under active development, and we'd love your [feedback](https://primer/doctocat-nextjs/discussions)! | ||
|
||
<p align="center"><strong>A Next.js theme for building Primer documentation sites</strong> | ||
</p> | ||
<br /> | ||
<a href="https://primer.github.io/doctocat-nextjs/"><img src="https://github.com/primer/doctocat-nextjs/assets/13340707/c7367bff-fb04-4be2-a1e5-90b2dee7de2d" width="200" alt="Button with label Try it out" /></a> | ||
<br /> | ||
<br /> | ||
|
||
<p align="center">🚧 Under active development 🚧 | ||
</p> | ||
📝 [Read the ADR for this project (GitHub staff only)](https://github.com/github/primer/blob/rezrah/prefer-nextjs-over-gatsby/adrs/2023-11-30-nextjs-documentation-framework.md) | ||
|
||
--- | ||
## Reporting a Bug | ||
|
||
### Useful links | ||
Thanks for taking the time to contribute! | ||
|
||
🔗 [See the working demo](https://primer.github.io/doctocat-nextjs/) | ||
While opening a new bug report, please ensure that the bug is: | ||
|
||
📝 [Read the ADR for this project](https://github.com/github/primer/blob/rezrah/prefer-nextjs-over-gatsby/adrs/2023-11-30-nextjs-documentation-framework.md) | ||
- **Reproducible**: Clearly outline the steps to reproduce the bug. | ||
- **Specific**: Include as much detail as possible: which browser and version you're using, which operating system and version you're using, etc. | ||
- **Unique**: Look through open [Issues](https://github.com/primer/doctocat-nextjs/labels/enhancement) to make sure that this bug has not been reported before. |