google
/
docsy
mirror of https://github.com/google/docsy.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add link to examples

This commit is contained in:
LisaFC 2021-02-02 13:39:31 +00:00 committed by GitHub
parent 18375335ff
commit 5dec904fb4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -22,12 +22,12 @@ The following are basic prerequisites for using Docsy in your site:
## Example and usage
You can find an example project that uses Docsy in the [Docsy Example Project repo](https://github.com/google/docsy-example).The Docsy Example Project is hosted at [https://example.docsy.dev/](https://example.docsy.dev/).
You can find an example project that uses Docsy in the [Docsy Example Project repo](https://github.com/google/docsy-example).The Docsy Example Project is hosted at [https://example.docsy.dev/](https://example.docsy.dev/). For real-life examples of sites that use Docsy (and their source repos), see our [Examples](https://www.docsy.dev/docs/examples/) page.
To use the Docsy theme for your own site:
- (Recommended) Copy the [example project](https://github.com/google/docsy-example),
which includes the Docsy theme as a submodule.
- (Recommended) Use the [example project](https://github.com/google/docsy-example),
which includes the Docsy theme as a submodule, as a template to create your project.
You can customize this pre-configured basic site into your own Docsy themed site.
[Learn more...](https://github.com/google/docsy-example)