You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docsy.dev/content/en/about/index.md
+92-39Lines changed: 92 additions & 39 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ linkTitle: About
4
4
description: >-
5
5
Docsy is a pre-configured Hugo theme that provides the core features and
6
6
behaviors needed to create a technical documentation site
7
-
menu: {main: {weight: 10}}
7
+
menu: {main: {weight: 10 } }
8
8
---
9
9
10
10
{{% blocks/cover
@@ -21,29 +21,56 @@ menu: {main: {weight: 10}}
21
21
22
22
{{% blocks/section color="white" %}}
23
23
24
-
Use Docsy to set up your documentation website, including an optional Blog section, and then spend your time focusing on authoring technical content. Depending on how you choose to configure Docsy and whether you use a hosting service that supports continuous builds, you can even just add your Markdown or HTML content file into a folder on your source repository, and then sit back while it automatically gets added to your site - complete with updated menus.
24
+
Use Docsy to set up your documentation website, including an optional Blog
25
+
section, and then spend your time focusing on authoring technical content.
26
+
Depending on how you choose to configure Docsy and whether you use a hosting
27
+
service that supports continuous builds, you can even just add your Markdown or
28
+
HTML content file into a folder on your source repository, and then sit back
29
+
while it automatically gets added to your site - complete with updated menus.
25
30
26
-
Read on to find out more, or visit our [documentation](/docs/) to get started!
31
+
To find out more, read on, or skip to the [documentation](/docs/). For project details, see the [project](/project/) page.
27
32
28
33
## So what’s a technical documentation site?
29
34
30
-
A technical documentation site is a website that your users can visit to find the documentation for your technical project. Your documentation set contains all the information you think your users might need to engage with your project, from overviews that help them understand what the project is for, to instructions for specific tasks. Depending on the size of the project, a documentation set can be a page or two or an entire “book” with different types of information.
31
-
32
-
**Most users don’t want to have to spend much time looking at docs - they want to try your great project!** So how do you make sure your technical documentation set gives users what they need to easily understand your project and get things done? We think a good technical documentation set should be:
33
-
34
-
***Reliable**: Is it true?
35
-
***Comprehensive**: Does it have all the information your target users might need?
36
-
***Well-organized and navigable**: Can the user find the information they need? Are similar types of information (all the information about a feature, all your reference information) grouped together?
37
-
38
-
If you have users around the world, you might also want to provide your content in multiple languages, and if you have an open source project, you’ll probably want your users to be able to contribute to the docs.
39
-
40
-
Once you have your content, you use a technical documentation site to publish your technical documentation set online for your users. In addition to your documentation, your site might also contain material like contact information, a blog, or information about how to contribute to the project.
35
+
A technical documentation site is a website that your users can visit to find
36
+
the documentation for your technical project. Your documentation set contains
37
+
all the information you think your users might need to engage with your project,
38
+
from overviews that help them understand what the project is for, to
39
+
instructions for specific tasks. Depending on the size of the project, a
40
+
documentation set can be a page or two or an entire “book” with different types
41
+
of information.
42
+
43
+
**Most users don’t want to have to spend much time looking at docs - they want
44
+
to try your great project!** So how do you make sure your technical
45
+
documentation set gives users what they need to easily understand your project
46
+
and get things done? We think a good technical documentation set should be:
47
+
48
+
-**Reliable**: Is it true?
49
+
-**Comprehensive**: Does it have all the information your target users might
50
+
need?
51
+
-**Well-organized and navigable**: Can the user find the information they need?
52
+
Are similar types of information (all the information about a feature, all
53
+
your reference information) grouped together?
54
+
55
+
If you have users around the world, you might also want to provide your content
56
+
in multiple languages, and if you have an open source project, you’ll probably
57
+
want your users to be able to contribute to the docs.
58
+
59
+
Once you have your content, you use a technical documentation site to publish
60
+
your technical documentation set online for your users. In addition to your
61
+
documentation, your site might also contain material like contact information, a
62
+
blog, or information about how to contribute to the project.
41
63
42
64
## How does Docsy help?
43
65
44
-
Particularly when working with open source projects, it can be difficult to figure out how to turn all your product knowledge into a website that helps and engages your users. **Enter Docsy!**
66
+
Particularly when working with open source projects, it can be difficult to
67
+
figure out how to turn all your product knowledge into a website that helps and
68
+
engages your users. **Enter Docsy!**
45
69
46
-
Docsy gives you a theme for the [Hugo](https://gohugo.io/) static site generator, an established open source tool that builds ready-to-serve websites from a set of theme and content files. The Docsy theme provides you with useful stuff for a technical documentation site that *isn’t* your own content:
70
+
Docsy gives you a theme for the [Hugo](https://gohugo.io/) static site
71
+
generator, an established open source tool that builds ready-to-serve websites
72
+
from a set of theme and content files. The Docsy theme provides you with useful
73
+
stuff for a technical documentation site that _isn’t_ your own content:
47
74
48
75
<table>
49
76
<tr>
@@ -92,51 +119,77 @@ Docsy gives you a theme for the [Hugo](https://gohugo.io/) static site generator
92
119
93
120
### Simple authoring and publishing
94
121
95
-
Author your content in the Markdown or HTML and then immediately test it with Hugo's local server. Once you are ready to
96
-
publish, add that content to your project and deploy it to your site using any of Hugo’s supported options.
122
+
Author your content in the Markdown or HTML and then immediately test it with
123
+
Hugo's local server. Once you are ready to publish, add that content to your
124
+
project and deploy it to your site using any of Hugo’s supported options.
97
125
[Learn more...](/docs/deployment/)
98
126
99
127
### Built-in integration with common tools
100
128
101
-
The Docsy template currently includes built-in integration with the following tools:
102
-
103
-
*[**GitHub**](https://github.com): Get in-page links directly to your GitHub repo and provide your users with a
104
-
convenient pathway to providing feedback, opening issues, and even suggesting changes through Pull Requests.
105
-
*[**Google Analytics**](https://analytics.google.com/analytics/web/): Easily connect your Google Analytics account to your
106
-
site.
107
-
*[**Google Custom Search**](https://cse.google.com/cse/): Use Google Custom Search for in-site search queries, or
108
-
configure your site to search the web.
109
-
*[**Algolia DocSearch**](https://docsearch.algolia.com): Let your users search your site with Algolia DocSearch.
110
-
*[**Lunr**](https://lunrjs.com/): Local indexing and search for your site without the need for external search services.
129
+
The Docsy template currently includes built-in integration with the following
130
+
tools:
131
+
132
+
-[**GitHub**](https://github.com): Get in-page links directly to your GitHub
133
+
repo and provide your users with a convenient pathway to providing feedback,
134
+
opening issues, and even suggesting changes through Pull Requests.
connect your Google Analytics account to your site.
137
+
-[**Google Custom Search**](https://cse.google.com/cse/): Use Google Custom
138
+
Search for in-site search queries, or configure your site to search the web.
139
+
-[**Algolia DocSearch**](https://docsearch.algolia.com): Let your users search
140
+
your site with Algolia DocSearch.
141
+
-[**Lunr**](https://lunrjs.com/): Local indexing and search for your site
142
+
without the need for external search services.
111
143
112
144
### Make it your own
113
145
114
-
You can configure the Docsy theme as much or as little as you like, anything from changing the colors and images to adding your own type of page layout. [Learn more...](/docs/content/lookandfeel/)
146
+
You can configure the Docsy theme as much or as little as you like, anything
147
+
from changing the colors and images to adding your own type of page layout.
148
+
[Learn more...](/docs/content/lookandfeel/)
115
149
116
150
### Get organized
117
151
118
-
We believe a well-organized documentation set can really help your users find the information they need, when they need it - whether it’s a “Hello World” tutorial when they’re starting out or a single core task they need to do to finish a complicated app. We also believe that having well-organized docs helps you create comprehensive docs, as it’s easier to see when you’re missing something important. [Learn more...](/docs/best-practices/organizing-content/)
152
+
We believe a well-organized documentation set can really help your users find
153
+
the information they need, when they need it - whether it’s a “Hello World”
154
+
tutorial when they’re starting out or a single core task they need to do to
155
+
finish a complicated app. We also believe that having well-organized docs helps
156
+
you create comprehensive docs, as it’s easier to see when you’re missing
Docsy also provides autogenerated site navigation based on how you organize your source files, so once you’ve organized your docs in folders in GitHub or other source control, you’ve got menus for your users to quickly reach the doc they need. [Learn more...](/docs/content/navigation/)
159
+
Docsy also provides autogenerated site navigation based on how you organize your
160
+
source files, so once you’ve organized your docs in folders in GitHub or other
161
+
source control, you’ve got menus for your users to quickly reach the doc they
162
+
need. [Learn more...](/docs/content/navigation/)
121
163
122
164
### Keep up to date
123
165
124
-
Spend time setting up your technical documentation site once, and then focus on what you do best. We work closely with
125
-
the Hugo team and have individuals actively maintaining the Docsy theme. You can easily get and
126
-
apply Docsy updates to your site, as well as open feature requests to improve the
127
-
template, or even add new behaviors. [Learn more...](/docs/updating/)
166
+
Spend time setting up your technical documentation site once, and then focus on
167
+
what you do best. We work closely with the Hugo team and have individuals
168
+
actively maintaining the Docsy theme. You can easily get and apply Docsy updates
169
+
to your site, as well as open feature requests to improve the template, or even
170
+
add new behaviors. [Learn more...](/docs/updating/)
128
171
129
172
### Focus on great content
130
173
131
-
Because Docsy helps you create and serve a well-organized, navigable technical documentation set, it frees you up to create and maintain great reliable, comprehensive content that your users can enjoy and trust.
174
+
Because Docsy helps you create and serve a well-organized, navigable technical
175
+
documentation set, it frees you up to create and maintain great reliable,
176
+
comprehensive content that your users can enjoy and trust.
132
177
133
178
## What's next for Docsy?
134
179
135
-
Docsy is an open source project and we love getting patches and contributions to make Docsy and its docs even better. We hope to continue to make improvements to the theme along with the Docsy community.
180
+
Docsy is an open source project and we love getting patches and contributions to
181
+
make Docsy and its docs even better. We hope to continue to make improvements to
182
+
the theme along with the Docsy community.
183
+
184
+
Visit our [Issues](https://github.com/google/docsy/issues) to see what we're
185
+
currently working on. If there's something you'd like to see in Docsy, please
186
+
create an issue yourself - or assign yourself an issue if you'd like to fix or
187
+
add something! See our [contribution guidelines](/docs/contribution-guidelines/)
188
+
for more information.
136
189
137
-
Visit our [Issues](https://github.com/google/docsy/issues) to see what we're currently working on. If there's something you'd like to see in Docsy, please create an issue yourself - or assign yourself an issue if you'd like to fix or add something! See our [contribution guidelines](/docs/contribution-guidelines/) for more information.
190
+
You can find out how to update your site to the latest version of Docsy in
191
+
[Keeping the theme up to date](/docs/updating/).
138
192
139
-
You can find out how to update your site to the latest version of Docsy in [Keeping the theme up to date](/docs/updating/).
140
193
<!-- There must not be a blank line at the end of this file otherwise it creates an empty paragraph in the rendered page -->
0 commit comments