mirror of
https://github.com/gohugoio/hugoDocs.git
synced 2025-10-05 07:20:09 -04:00
50 lines
1.2 KiB
Markdown
50 lines
1.2 KiB
Markdown
---
|
|
title: Using the Hugo Docs
|
|
linktitle: Using the Hugo Docs
|
|
description: The Hugo docs are optimized for consistency. Whenever possible, code samples and tutorials pull from a single example site. Doc content is grouped together to make learning Hugo easier and even more fun.
|
|
date: 2017-02-01
|
|
publishdate: 2017-02-01
|
|
lastmod: 2017-02-01
|
|
categories: [getting started]
|
|
tags: [usage,docs,fundamentals]
|
|
tags_weight: 01
|
|
weight: 20
|
|
draft: true
|
|
aliases: [/getting-started/using-the-docs/]
|
|
toc: true
|
|
wip: true
|
|
notesforauthors:
|
|
wip: true
|
|
---
|
|
|
|
## Example Site
|
|
|
|
## Code Samples
|
|
|
|
Throughout the docs, you'll see four different types of code blocks.
|
|
|
|
### Standard
|
|
|
|
This should be obvious.
|
|
|
|
### Input Code Blocks (Copyable)
|
|
|
|
### Output Code Blocks
|
|
|
|
### Example Site Code Blocks
|
|
|
|
## Admonitions
|
|
|
|
### Note Admonitiion
|
|
|
|
### Warning Admonition
|
|
|
|
## Help Us Improve our Documentation
|
|
|
|
Interested in helping us improve the Hugo docs?
|
|
|
|
1. We've developed a [step-by-step guide for docs contributors][contributedocs] on how to submit a pull request after making changes locally.
|
|
2. If you're not up for git and GitHub, start a thread on the ["docs" category in the Hugo Forums][hugodiscussion]
|
|
|
|
[hugodiscussion]: https://discuss.gohugo.io/c/feature
|
|
[contributedocs]: /contribute/documentation/ |