Skip to content

Commit cc9a192

Browse files
mayankshah1607mayankshah1607
committed
Initial commit
Signed-off-by: Mayank Shah <[email protected]>
0 parents  commit cc9a192

File tree

7,528 files changed

+432122
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

7,528 files changed

+432122
-0
lines changed

‎.gitignore

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
/public
2+
resources/
3+
node_modules/
4+
package-lock.json

‎.gitmodules

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
2+
[submodule "themes/docsy"]
3+
path = themes/docsy
4+
url = https://github.com/google/docsy

‎README.md

+122
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,122 @@
1+
# Docsy Example
2+
3+
[Docsy][] is a [Hugo theme][] for technical documentation sites, providing easy
4+
site navigation, structure, and more. This **Docsy Example Project** uses the
5+
Docsy theme and provides a skeleton documentation structure for you to use. You
6+
can clone/copy this project and edit it with your own content, or use it as an
7+
example.
8+
9+
In this project, the Docsy theme is included as a Git submodule:
10+
11+
```bash
12+
$ git submodule
13+
...<hash>... themes/docsy (remotes/origin/HEAD)
14+
```
15+
16+
You can find detailed theme instructions in the [Docsy user guide][].
17+
18+
This Docsy Example Project is hosted on [Netlify][] at [example.docsy.dev][].
19+
You can view deploy logs from the [deploy section of the project's Netlify
20+
dashboard][deploys], or this [alternate dashboard][].
21+
22+
This is not an officially supported Google product. This project is currently maintained.
23+
24+
## Using the Docsy Example Project as a template
25+
26+
A simple way to get started is to use this project as a template, which gives you a site project that is set up and ready to use. To do this:
27+
28+
1. Click **Use this template**.
29+
30+
2. Select a name for your new project and click **Create repository from template**.
31+
32+
3. Make your own local working copy of your new repo using git clone, replacing https://github.com/my/example.git with your repo’s web URL:
33+
34+
```bash
35+
git clone --recurse-submodules --depth 1 https://github.com/my/example.git
36+
```
37+
38+
You can now edit your own versions of the site’s source files.
39+
40+
If you want to do SCSS edits and want to publish these, you need to install `PostCSS`
41+
42+
```bash
43+
npm install
44+
```
45+
46+
## Running the website locally
47+
48+
Building and running the site locally requires a recent `extended` version of [Hugo](https://gohugo.io).
49+
You can find out more about how to install Hugo for your environment in our
50+
[Getting started](https://www.docsy.dev/docs/getting-started/#prerequisites-and-installation) guide.
51+
52+
Once you've made your working copy of the site repo, from the repo root folder, run:
53+
54+
```
55+
hugo server
56+
```
57+
58+
## Running a container locally
59+
60+
You can run docsy-example inside a [Docker](https://docs.docker.com/)
61+
container, the container runs with a volume bound to the `docsy-example`
62+
folder. This approach doesn't require you to install any dependencies other
63+
than [Docker Desktop](https://www.docker.com/products/docker-desktop) on
64+
Windows and Mac, and [Docker Compose](https://docs.docker.com/compose/install/)
65+
on Linux.
66+
67+
1. Build the docker image
68+
69+
```bash
70+
docker-compose build
71+
```
72+
73+
1. Run the built image
74+
75+
```bash
76+
docker-compose up
77+
```
78+
79+
> NOTE: You can run both commands at once with `docker-compose up --build`.
80+
81+
1. Verify that the service is working.
82+
83+
Open your web browser and type `http://localhost:1313` in your navigation bar,
84+
This opens a local instance of the docsy-example homepage. You can now make
85+
changes to the docsy example and those changes will immediately show up in your
86+
browser after you save.
87+
88+
### Cleanup
89+
90+
To stop Docker Compose, on your terminal window, press **Ctrl + C**.
91+
92+
To remove the produced images run:
93+
94+
```console
95+
docker-compose rm
96+
```
97+
For more information see the [Docker Compose
98+
documentation](https://docs.docker.com/compose/gettingstarted/).
99+
100+
## Troubleshooting
101+
102+
As you run the website locally, you may run into the following error:
103+
104+
```
105+
➜ hugo server
106+
107+
INFO 2021/01/21 21:07:55 Using config file:
108+
Building sites … INFO 2021/01/21 21:07:55 syncing static files to /
109+
Built in 288 ms
110+
Error: Error building site: TOCSS: failed to transform "scss/main.scss" (text/x-scss): resource "scss/scss/main.scss_9fadf33d895a46083cdd64396b57ef68" not found in file cache
111+
```
112+
113+
This error occurs if you have not installed the extended version of Hugo.
114+
See our [user guide](https://www.docsy.dev/docs/getting-started/) for instructions on how to install Hugo.
115+
116+
[alternate dashboard]: https://app.netlify.com/sites/goldydocs/deploys
117+
[deploys]: https://app.netlify.com/sites/docsy-example/deploys
118+
[Docsy user guide]: https://docsy.dev/docs
119+
[Docsy]: https://github.com/google/docsy
120+
[example.docsy.dev]: https://example.docsy.dev
121+
[Hugo theme]: https://gohugo.io/themes/installing-and-using-themes/
122+
[Netlify]: https://netlify.com

‎assets/scss/_variables_project.scss

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
/*
2+
3+
Add styles or override variables from the theme here.
4+
5+
*/
6+

‎config.toml

+223
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,223 @@
1+
baseURL = "/"
2+
title = "Goldydocs"
3+
4+
enableRobotsTXT = true
5+
6+
# Hugo allows theme composition (and inheritance). The precedence is from left to right.
7+
theme = ["docsy"]
8+
9+
# Will give values to .Lastmod etc.
10+
enableGitInfo = true
11+
12+
# Language settings
13+
contentDir = "content/en"
14+
defaultContentLanguage = "en"
15+
defaultContentLanguageInSubdir = false
16+
# Useful when translating.
17+
enableMissingTranslationPlaceholders = true
18+
19+
# Comment out to disable taxonomies in Docsy
20+
# disableKinds = ["taxonomy", "taxonomyTerm"]
21+
22+
# You can add your own taxonomies
23+
[taxonomies]
24+
tag = "tags"
25+
category = "categories"
26+
27+
[params.taxonomy]
28+
# set taxonomyCloud = [] to hide taxonomy clouds
29+
taxonomyCloud = ["tags", "categories"]
30+
31+
# If used, must have same lang as taxonomyCloud
32+
taxonomyCloudTitle = ["Tag Cloud", "Categories"]
33+
34+
# set taxonomyPageHeader = [] to hide taxonomies on the page headers
35+
taxonomyPageHeader = ["tags", "categories"]
36+
37+
38+
# Highlighting config
39+
pygmentsCodeFences = true
40+
pygmentsUseClasses = false
41+
# Use the new Chroma Go highlighter in Hugo.
42+
pygmentsUseClassic = false
43+
#pygmentsOptions = "linenos=table"
44+
# See https://help.farbox.com/pygments.html
45+
pygmentsStyle = "tango"
46+
47+
# Configure how URLs look like per section.
48+
[permalinks]
49+
blog = "/:section/:year/:month/:day/:slug/"
50+
51+
## Configuration for BlackFriday markdown parser: https://github.com/russross/blackfriday
52+
[blackfriday]
53+
plainIDAnchors = true
54+
hrefTargetBlank = true
55+
angledQuotes = false
56+
latexDashes = true
57+
58+
# Image processing configuration.
59+
[imaging]
60+
resampleFilter = "CatmullRom"
61+
quality = 75
62+
anchor = "smart"
63+
64+
[services]
65+
[services.googleAnalytics]
66+
# Comment out the next line to disable GA tracking. Also disables the feature described in [params.ui.feedback].
67+
id = "UA-00000000-0"
68+
69+
# Language configuration
70+
71+
[languages]
72+
[languages.en]
73+
title = "Goldydocs"
74+
description = "A Docsy example site"
75+
languageName ="English"
76+
# Weight used for sorting.
77+
weight = 1
78+
[languages.no]
79+
title = "Goldydocs"
80+
description = "Docsy er operativsystem for skyen"
81+
languageName ="Norsk"
82+
contentDir = "content/no"
83+
time_format_default = "02.01.2006"
84+
time_format_blog = "02.01.2006"
85+
86+
[languages.fa]
87+
title = "اسناد گلدی"
88+
description = "یک نمونه برای پوسته داکسی"
89+
languageName ="فارسی"
90+
contentDir = "content/fa"
91+
time_format_default = "2006.01.02"
92+
time_format_blog = "2006.01.02"
93+
94+
[markup]
95+
[markup.goldmark]
96+
[markup.goldmark.renderer]
97+
unsafe = true
98+
[markup.highlight]
99+
# See a complete list of available styles at https://xyproto.github.io/splash/docs/all.html
100+
style = "tango"
101+
# Uncomment if you want your chosen highlight style used for code blocks without a specified language
102+
# guessSyntax = "true"
103+
104+
# Everything below this are Site Params
105+
106+
# Comment out if you don't want the "print entire section" link enabled.
107+
[outputs]
108+
section = ["HTML", "print", "RSS"]
109+
110+
[params]
111+
copyright = "The Docsy Authors"
112+
privacy_policy = "https://policies.google.com/privacy"
113+
114+
# First one is picked as the Twitter card image if not set on page.
115+
# images = ["images/project-illustration.png"]
116+
117+
# Menu title if your navbar has a versions selector to access old versions of your site.
118+
# This menu appears only if you have at least one [params.versions] set.
119+
version_menu = "Releases"
120+
121+
# Flag used in the "version-banner" partial to decide whether to display a
122+
# banner on every page indicating that this is an archived version of the docs.
123+
# Set this flag to "true" if you want to display the banner.
124+
archived_version = false
125+
126+
# The version number for the version of the docs represented in this doc set.
127+
# Used in the "version-banner" partial to display a version number for the
128+
# current doc set.
129+
version = "0.0"
130+
131+
# A link to latest version of the docs. Used in the "version-banner" partial to
132+
# point people to the main doc site.
133+
url_latest_version = "https://example.com"
134+
135+
# Repository configuration (URLs for in-page links to opening issues and suggesting changes)
136+
github_repo = "https://github.com/google/docsy-example"
137+
# An optional link to a related project repo. For example, the sibling repository where your product code lives.
138+
github_project_repo = "https://github.com/google/docsy"
139+
140+
# Specify a value here if your content directory is not in your repo's root directory
141+
# github_subdir = ""
142+
143+
# Uncomment this if you have a newer GitHub repo with "main" as the default branch,
144+
# or specify a new value if you want to reference another branch in your GitHub links
145+
# github_branch= "main"
146+
147+
# Google Custom Search Engine ID. Remove or comment out to disable search.
148+
gcs_engine_id = "d72aa9b2712488cc3"
149+
150+
# Enable Algolia DocSearch
151+
algolia_docsearch = false
152+
153+
# Enable Lunr.js offline search
154+
offlineSearch = false
155+
156+
# Enable syntax highlighting and copy buttons on code blocks with Prism
157+
prism_syntax_highlighting = false
158+
159+
# User interface configuration
160+
[params.ui]
161+
# Set to true to disable breadcrumb navigation.
162+
breadcrumb_disable = false
163+
# Set to true to disable the About link in the site footer
164+
footer_about_disable = false
165+
# Set to false if you don't want to display a logo (/assets/icons/logo.svg) in the top navbar
166+
navbar_logo = true
167+
# Set to true if you don't want the top navbar to be translucent when over a `block/cover`, like on the homepage.
168+
navbar_translucent_over_cover_disable = false
169+
# Enable to show the side bar menu in its compact state.
170+
sidebar_menu_compact = false
171+
# Set to true to hide the sidebar search box (the top nav search box will still be displayed if search is enabled)
172+
sidebar_search_disable = false
173+
174+
# Adds a H2 section titled "Feedback" to the bottom of each doc. The responses are sent to Google Analytics as events.
175+
# This feature depends on [services.googleAnalytics] and will be disabled if "services.googleAnalytics.id" is not set.
176+
# If you want this feature, but occasionally need to remove the "Feedback" section from a single page,
177+
# add "hide_feedback: true" to the page's front matter.
178+
[params.ui.feedback]
179+
enable = true
180+
# The responses that the user sees after clicking "yes" (the page was helpful) or "no" (the page was not helpful).
181+
yes = 'Glad to hear it! Please <a href="https://github.com/USERNAME/REPOSITORY/issues/new">tell us how we can improve</a>.'
182+
no = 'Sorry to hear that. Please <a href="https://github.com/USERNAME/REPOSITORY/issues/new">tell us how we can improve</a>.'
183+
184+
# Adds a reading time to the top of each doc.
185+
# If you want this feature, but occasionally need to remove the Reading time from a single page,
186+
# add "hide_readingtime: true" to the page's front matter
187+
[params.ui.readingtime]
188+
enable = false
189+
190+
[params.links]
191+
# End user relevant links. These will show up on left side of footer and in the community page if you have one.
192+
[[params.links.user]]
193+
name = "User mailing list"
194+
url = "https://example.org/mail"
195+
icon = "fa fa-envelope"
196+
desc = "Discussion and help from your fellow users"
197+
[[params.links.user]]
198+
name ="Twitter"
199+
url = "https://example.org/twitter"
200+
icon = "fab fa-twitter"
201+
desc = "Follow us on Twitter to get the latest news!"
202+
[[params.links.user]]
203+
name = "Stack Overflow"
204+
url = "https://example.org/stack"
205+
icon = "fab fa-stack-overflow"
206+
desc = "Practical questions and curated answers"
207+
# Developer relevant links. These will show up on right side of footer and in the community page if you have one.
208+
[[params.links.developer]]
209+
name = "GitHub"
210+
url = "https://github.com/google/docsy"
211+
icon = "fab fa-github"
212+
desc = "Development takes place here!"
213+
[[params.links.developer]]
214+
name = "Slack"
215+
url = "https://example.org/slack"
216+
icon = "fab fa-slack"
217+
desc = "Chat with other project developers"
218+
[[params.links.developer]]
219+
name = "Developer mailing list"
220+
url = "https://example.org/mail"
221+
icon = "fa fa-envelope"
222+
desc = "Discuss development issues around the project"
223+

0 commit comments

Comments
 (0)