Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

User guide: curate main menu #945

Merged
merged 1 commit into from
Mar 28, 2022
Merged

User guide: curate main menu #945

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
8 changes: 1 addition & 7 deletions userguide/config.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,13 +51,7 @@ anchor = "smart"
name = "Example Site"
weight = 40
url = "https://example.docsy.dev"
pre = "<i class='fas fa-laptop-code'></i>"
[[menu.main]]
name = "GitHub"
weight = 50
url = "https://github.com/google/docsy/"
pre = "<i class='fab fa-github'></i>"
post = "<span class='alert'>New!</span>"
post = '<sup><i class="pl-1 fas fa-external-link-alt fa-xs" aria-hidden="true"></i></sup>'

[services]
[services.googleAnalytics]
Expand Down
17 changes: 7 additions & 10 deletions userguide/content/en/about/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,7 @@
---
title: About Docsy
linkTitle: About
menu:
main:
weight: 10
pre: <i class='fas fa-info-circle'></i>
menu: {main: {weight: 10}}
layout: docs
---

Expand Down Expand Up @@ -86,7 +83,7 @@ Docsy gives you a theme for the [Hugo](https://gohugo.io/) static site generator
### Simple authoring and publishing

Author your content in the Markdown or HTML and then immediately test it with Hugo's local server. Once you are ready to
publish, add that content to your project and deploy it to your site using any of Hugo’s supported options.
publish, add that content to your project and deploy it to your site using any of Hugo’s supported options.
[Learn more...](/docs/deployment/)

### Built-in integration with common tools
Expand All @@ -95,9 +92,9 @@ The Docsy template currently includes built-in integration with the following to

* [**GitHub**](https://github.com): Get in-page links directly to your GitHub repo and provide your users with a
convenient pathway to providing feedback, opening issues, and even suggesting changes through Pull Requests.
* [**Google Analytics**](https://analytics.google.com/analytics/web/): Easily connect your Google Analytics account to your
* [**Google Analytics**](https://analytics.google.com/analytics/web/): Easily connect your Google Analytics account to your
site.
* [**Google Custom Search**](https://cse.google.com/cse/): Use Google Custom Search for in-site search queries, or
* [**Google Custom Search**](https://cse.google.com/cse/): Use Google Custom Search for in-site search queries, or
configure your site to search the web.
* [**Algolia DocSearch**](https://community.algolia.com/docsearch/): Let your users search your site with Algolia DocSearch.
* [**Lunr**](https://lunrjs.com/): Local indexing and search for your site without the need for external search services.
Expand All @@ -115,9 +112,9 @@ Docsy also provides autogenerated site navigation based on how you organize your

### Keep up to date

Spend time setting up your technical documentation site once, and then focus on what you do best. We work closely with
the Hugo team and have individuals actively maintaining the Docsy theme. You can easily get and
apply Docsy updates to your site, as well as open feature requests to improve the
Spend time setting up your technical documentation site once, and then focus on what you do best. We work closely with
the Hugo team and have individuals actively maintaining the Docsy theme. You can easily get and
apply Docsy updates to your site, as well as open feature requests to improve the
template, or even add new behaviors. [Learn more...](/docs/updating/)


Expand Down
5 changes: 1 addition & 4 deletions userguide/content/en/community/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
---
title: Community
menu:
main:
weight: 40
pre: <i class='fas fa-users'></i>
menu: {main: {weight: 40}}
---

<!--add blocks of content here to add more sections to the community page -->
17 changes: 7 additions & 10 deletions userguide/content/en/docs/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,28 +1,25 @@

---
title: "Welcome to Docsy"
linkTitle: "Documentation"
menu:
main:
weight: 20
pre: <i class='fas fa-book'></i>
title: Welcome to Docsy
linkTitle: Documentation
menu: {main: {weight: 20}}
---

Welcome to the Docsy theme user guide! This guide shows you how to get started creating technical documentation sites using Docsy, including site customization and how to use Docsy's blocks and templates.

## What is Docsy?

Docsy is a theme for the [Hugo](https://gohugo.io/) static site generator that's specifically designed for technical
documentation sets and has a lot of best practices built in. Use Docsy to get a working and reliable documentation
site up and running fast, and then get back to focusing on great content for your users.
Docsy is a theme for the [Hugo](https://gohugo.io/) static site generator that's specifically designed for technical
documentation sets and has a lot of best practices built in. Use Docsy to get a working and reliable documentation
site up and running fast, and then get back to focusing on great content for your users.
[Learn more about Docsy](/about).

In addition to the theme itself, we provide an [example site](https://github.com/google/docsy-example) that uses lots of Docsy features and has a useful skeleton site structure (with advice for what to put in it!) for a large technical documentation set. You can copy the entire site and edit it for your own projects, or just explore the site and its source to see what Docsy can do. The site you're currently reading also uses Docsy and is a useful example of a smaller Docsy docset: feel free to copy it or borrow from it if it suits your needs better than the "big" example.

Docsy itself does **not** provide:

* **Source hosting and management**: Our theme and site source files live on [GitHub](https://github.com/), which is the simplest approach for most projects. However, you can also keep your project files in [GitLab](https://about.gitlab.com/), [BitBucket](https://bitbucket.org/product), locally, or wherever you like. Be aware that where your source files live may affect the Docsy features you can use (such as letting users file documentation issues) and site deployment options.
* **Site deployment**: You can find out about deployment options in [Previews and Deployment](./deployment/). This site uses [Netlify](https://www.netlify.com/).
* **Site deployment**: You can find out about deployment options in [Previews and Deployment](./deployment/). This site uses [Netlify](https://www.netlify.com/).

Docsy also doesn't actually generate your site's HTML files: that's Hugo's job! Hugo takes your Markdown or HTML doc source files and Docsy's theme files and builds them into a static site for deployment. You can find out more about Hugo and how it works in the [Hugo documentation](https://gohugo.io/documentation/).

Expand Down