mirror of
https://github.com/gohugoio/hugo.git
synced 2026-08-24 15:28:54 +00:00
Fix fontello for blockquotes icon
This commit is contained in:
@@ -1,5 +1,5 @@
|
||||
---
|
||||
title: Contribute to Hugo
|
||||
title: Contributing to the Hugo Project
|
||||
linktitle: Overview
|
||||
description: Contribute to Hugo development and documentation.
|
||||
date: 2017-02-01
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Contribute to Hugo Development
|
||||
linktitle: Code
|
||||
linktitle: Development
|
||||
description: Hugo relies heavily on contributions from the open source community. You don't need to be a Golang guru to contribute to the project's development.
|
||||
date: 2017-02-01
|
||||
publishdate: 2017-02-01
|
||||
@@ -12,8 +12,6 @@ weight: 10
|
||||
draft: false
|
||||
aliases: [/contribute/development/]
|
||||
toc: true
|
||||
wip: true
|
||||
notesforauthors:
|
||||
---
|
||||
|
||||
## Introduction
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Contribute to the Hugo Docs
|
||||
linktitle: Docs
|
||||
linktitle: Documentation
|
||||
description: Documentation is an integral part of any open source project. The Hugo docs are as much a work in progress as the source it attempts to teach its users.
|
||||
date: 2017-02-01
|
||||
publishdate: 2017-02-01
|
||||
@@ -17,9 +17,9 @@ Documentation is a critical component of any open-source project. The Hugo docs
|
||||
|
||||
## Create Your Fork
|
||||
|
||||
It's best to make changes to the Hugo docs on your local machine to check for consistent visual styling. Make sure you've created a fork of Hugo on GitHub and cloned the repository locally on your machine. For more information, you can see[GitHub's documentation on "forking"][ghforking] or follow along with [Hugo's evelopment contribution guide][hugodev].
|
||||
It's best to make changes to the Hugo docs on your local machine to check for consistent visual styling. Make sure you've created a fork of Hugo on GitHub and cloned the repository locally on your machine. For more information, you can see [GitHub's documentation on "forking"][ghforking] or follow along with [Hugo's development contribution guide][hugodev].
|
||||
|
||||
You can then create a separate branch for your additions. Choose a different descriptive branch name that best fits the type of content. The following is an example of a branch name you might use for adding a new website to the showcase:
|
||||
You can then create a separate branch for your additions. Be sure to choose a descriptive branch name that best fits the type of content. The following is an example of a branch name you might use for adding a new website to the showcase:
|
||||
|
||||
```git
|
||||
git checkout -b jon-doe-showcase-addition
|
||||
@@ -27,7 +27,7 @@ git checkout -b jon-doe-showcase-addition
|
||||
|
||||
## Adding New Content
|
||||
|
||||
The Hugo docs make heavy use of Hugo's [archetypes][] feature to easily scaffold new instances of content types. All content sections in Hugo documentation have an assigned archetype. You can [see the Hugo docs archetype source][archsource] for more clarity.
|
||||
The Hugo docs make heavy use of Hugo's [archetypes][] feature. All content sections in Hugo documentation have an assigned archetype.
|
||||
|
||||
Adding new content to the Hugo docs follows the same pattern, regardless of the content section:
|
||||
|
||||
@@ -171,11 +171,11 @@ The Hugo documentation comes with very robust shortcodes to help you add interac
|
||||
With the `code` shortcodes, *you must include triple back ticks and a language declaration*. This was done by design so that the shortcode wrappers were easily added to legacy documentation and will be that much easier to remove if needed in future versions of the Hugo docs. We assume that the triple-back-tick syntax will live longer than our current, pretty shortcode.
|
||||
{{% /note %}}
|
||||
|
||||
#### `code`
|
||||
### `code`
|
||||
|
||||
`code` is the code block shortcode you'll use most often. `code` requires at least a single `file` named parameter. Here is the signature:
|
||||
`code` is the code block shortcode you'll use most often. `code` requires at least a single `file` named parameter. Here is the pattern:
|
||||
|
||||
````golang
|
||||
````markdown
|
||||
{{%/* code file="smart/file/name/with/path.html" download="download.html" copy="true" */%}}
|
||||
```language
|
||||
A whole bunch of coding going on up in here! Boo-yah!
|
||||
@@ -194,14 +194,14 @@ These are the arguments passed into `code`
|
||||
`copy`
|
||||
: a copy button is added automatically to all `code` (i.e., default value = `true`). If you want to keep the filename and styling of `code` but don't want to encourage readers to copy the code (e.g., a "Do not do" snippet in a tutorial), pass the `copy` argument as `copy="false"`.
|
||||
|
||||
##### Example `code` Input
|
||||
#### Example `code` Input
|
||||
|
||||
Here is an HTML code block in a case where we want to show the user of the Hugo docs the following:
|
||||
This HTML code block tells Hugo users the following:
|
||||
|
||||
1. This type of file *could* live in `layouts/_default`.
|
||||
2. This snippet is complete enough that it might be worth downloading as a standalone file.
|
||||
1. This file *could* live in `layouts/_default`, as demonstrated by `layouts/_default/single.html`.
|
||||
2. This snippet is complete enough to be downloaded an implement in a Hugo project, as demonstrated by `download="single.html".`
|
||||
|
||||
````html
|
||||
````md
|
||||
{{%/* code file="layouts/_default/single.html" download="single.html" */%}}
|
||||
```html
|
||||
{{ define "main" }}
|
||||
@@ -253,7 +253,7 @@ The output of this example will render to the Hugo docs as follows:
|
||||
|
||||
Cool, right?
|
||||
|
||||
#### Output Code Block
|
||||
<!-- #### Output Code Block
|
||||
|
||||
The `output` shortcode is almost identical to the `code` shortcode but only takes and requires `file`. The purpose of `output` is to show *rendered* HTML and therefore almost always follows another basic code block *or* and instance of the `code` shortcode:
|
||||
|
||||
@@ -273,7 +273,7 @@ The preceding `output` example will render as follows to the Hugo docs:
|
||||
<h1>This is my First Hugo Blog Post</h1>
|
||||
<p>I am excited to be using Hugo.</p>
|
||||
```
|
||||
{{% /output %}}
|
||||
{{% /output %}} -->
|
||||
|
||||
## Blockquotes
|
||||
|
||||
@@ -290,7 +290,7 @@ The preceding blockquote will render as follows in the Hugo docs:
|
||||
However, you can add a quick and easy `<cite>` element (added on the client via JavaScript) by separating your main blockquote and the citation with ` - `:
|
||||
|
||||
```markdown
|
||||
> Without the threat of punishment, there is no joy in flight. - [Kobo Abe](https://en.wikipedia.org/wiki/K%C5%8Db%C5%8D_Abe)
|
||||
> Without the threat of punishment, there is no joy in flight. - [Kobo Abe](https://en.wikipedia.org/wiki/Kobo_Abe)
|
||||
```
|
||||
|
||||
Which will render as follows on the Hugo docs:
|
||||
@@ -316,7 +316,7 @@ Use the `note` shortcode when you want to draw attention to information subtly.
|
||||
#### Example `note` Input
|
||||
|
||||
{{% code file="note-with-heading.md" %}}
|
||||
```golang
|
||||
```markdown
|
||||
{{%/* note "Example Note Admonition" */%}}
|
||||
Here is a piece of information I would like to draw your **attention** to.
|
||||
{{%/* /note */%}}
|
||||
@@ -346,7 +346,7 @@ Use the `warning` shortcode when you want to draw the user's attention to someth
|
||||
#### Example `warning` Input
|
||||
|
||||
{{% code file="warning-admonition-input.md" %}}
|
||||
```golang
|
||||
```markdown
|
||||
{{%/* warning "Example Warning Admonition" */%}}
|
||||
This is a warning, which should be reserved for *important* information like breaking changes.
|
||||
{{%/* /warning */%}}
|
||||
@@ -369,17 +369,6 @@ This is a warning, which should be reserved for *important* information like bre
|
||||
This is a warning, which should be reserved for *important* information like breaking changes.
|
||||
{{% /warning %}}
|
||||
|
||||
## Editorial Style Guide
|
||||
|
||||
{{% note %}}
|
||||
It's more important to contribute *some* documentation than no documentation at all. We need your help!
|
||||
{{% /note %}}
|
||||
|
||||
The Hugo docs are not especially prescriptive in terms of grammar and usage. We encourage everyone to contribute regardless of your writing style. That said, here are a few gotchas when writing your documentation that, if observed, will create a more consistent documentation experience for the Hugo community:
|
||||
|
||||
1. *Front matter* and *file system* are two words; *Homepage* is one word.
|
||||
3. Add a `godocref` value to the front matter of content files whenever possible. We want to promote Hugo *and* Golang by demonstrating the inseparable wedding of the two.
|
||||
|
||||
## Ask for Code Examples
|
||||
|
||||
Sometimes you want to contribute to the docs but don't have enough time to provide lengthy examples. If you want to flag a piece of content as needing more examples, add the following field to your front matter:
|
||||
@@ -398,9 +387,8 @@ The preceding `needsexamples` field is used to generate the following list of fl
|
||||
Similar to [contributing to Hugo development](/contribute/development/), the Hugo team expects you to create a separate branch/fork when you make your generous contributions to the Hugo docs.
|
||||
{{% /note %}}
|
||||
|
||||
[abe]: https://en.wikipedia.org/wiki/K%C5%8Db%C5%8D_Abe
|
||||
[abe]: https://en.wikipedia.org/wiki/Kobo_Abe
|
||||
[archetypes]: /content-management/archetypes/
|
||||
[archsource]: https://github.com/spf13/hugo/tree/master/docs/archetypes
|
||||
[bqsyntax]: https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet#blockquotes
|
||||
[charcount]: http://www.lettercount.com/
|
||||
[ghforking]: https://help.github.com/articles/fork-a-repo/
|
||||
|
||||
File diff suppressed because one or more lines are too long
@@ -65,11 +65,13 @@
|
||||
.icon-clock:before { content: '\e817'; } /* '' */
|
||||
.icon-code:before { content: '\f121'; } /* '' */
|
||||
.icon-cog-alt:before { content: '\e816'; } /* '' */
|
||||
.icon-discuss:before { content: '\f03d'; } /* '' */
|
||||
.icon-docs:before { content: '\f0c5'; } /* '' */
|
||||
.icon-download:before { content: '\e806'; } /* '' */
|
||||
.icon-edge:before { content: '\f282'; } /* '' */
|
||||
.icon-file-pdf:before { content: '\f1c1'; } /* '' */
|
||||
.icon-firefox:before { content: '\e840'; } /* '' */
|
||||
.icon-forum:before { content: '\f03d'; } /* '' */
|
||||
.icon-forums:before { content: '\f03d'; } /* '' */
|
||||
.icon-freebsd:before { content: '\e800'; } /* '' */
|
||||
.icon-git:before { content: '\f1d3'; } /* '' */
|
||||
@@ -92,6 +94,8 @@
|
||||
.icon-opera:before { content: '\e842'; } /* '' */
|
||||
.icon-pencil:before { content: '\e807'; } /* '' */
|
||||
.icon-pin:before { content: '\e811'; } /* '' */
|
||||
.icon-quote-left:before { content: '\e819'; } /* '' */
|
||||
.icon-quote-right:before { content: '\e81a'; } /* '' */
|
||||
.icon-search:before { content: '\e803'; } /* '' */
|
||||
.icon-tag:before { content: '\e80d'; } /* '' */
|
||||
.icon-tags:before { content: '\e80c'; } /* '' */
|
||||
|
||||
@@ -20,12 +20,11 @@
|
||||
display: block;
|
||||
@include size(1em);
|
||||
position: absolute;
|
||||
content: '\e809';
|
||||
content: '\e819';
|
||||
color:$hugo-gray-light;
|
||||
top: -3px;
|
||||
left: 4px;
|
||||
font-size: 1.2em;
|
||||
// background-color: $body-bg-color;
|
||||
font-style: normal;
|
||||
}
|
||||
code,pre {
|
||||
|
||||
Vendored
+1
-1
File diff suppressed because one or more lines are too long
Binary file not shown.
@@ -56,6 +56,10 @@
|
||||
|
||||
<glyph glyph-name="md" unicode="" d="M1367-94l-1249 0c-59 0-106 47-106 106l0 685c0 59 47 106 106 106l1249 0c58 0 106-47 106-106l0-687c-3-57-50-104-106-104l0 0z m-1249 827c-20 0-36-16-36-36l0-687c0-21 16-37 36-37l1249 0c20 0 36 16 36 37l0 687c0 20-16 36-36 36l-1249 0 0 0z m104-617l0 475 139 0 140-176 140 176 140 0 0-478-140 0 0 275-140-176-140 176 0-272-139 0z m876 0l-209 232 140 0 0 243 139 0 0-246 140 0-210-229 0 0z" horiz-adv-x="1488" />
|
||||
|
||||
<glyph glyph-name="quote-left" unicode="" d="M911 16l-335 0 0 335q0 139 99 236t236 98l0-111q-93 0-158-66t-65-157l223 0 0-335z m-558 0l-335 0 0 335q0 139 98 236t237 98l0-111q-93 0-158-66t-65-157l223 0 0-335z" horiz-adv-x="928" />
|
||||
|
||||
<glyph glyph-name="quote-right" unicode="" d="M18 685l335 0 0-334q0-140-98-238t-237-97l0 111q92 0 158 65t65 159l-223 0 0 334z m558 0l335 0 0-334q0-140-98-238t-237-97l0 111q92 0 158 65t65 159l-223 0 0 334z" horiz-adv-x="928" />
|
||||
|
||||
<glyph glyph-name="firefox" unicode="" d="M504-137c-216 0-387 126-466 306-87 200-17 521 139 663l-6-156c8 9 68 12 78-1 32 62 136 109 220 110-32-26-106-124-99-174 40-13 103-13 136-15 10-6 8-40-12-68-27-36-97-49-97-49l8-106-77 38c-26-64 35-120 97-110 69 12 94 57 142 54 49-2 68-29 61-54-7-30-59-25-59-25-44-70-103-100-198-92 144-119 338-11 387 86 50 97 7 242-43 283 59-25 99-51 120-107 11 124-46 266-149 349 193-56 311-205 314-444 3-239-211-488-496-488z" horiz-adv-x="1000" />
|
||||
|
||||
<glyph glyph-name="chrome" unicode="" d="M498 850c-147-1-291-67-387-186l154-237c39 111 150 182 267 170l414-22c-42 84-108 157-196 208-79 46-166 67-252 67z m-416-226c-52-79-82-173-82-274 0-250 183-457 423-494l128 252c-116-22-233 39-281 146l-188 370z m885-94l-282-15c76-89 82-221 13-317l-226-347c94-6 190 15 278 66 216 125 304 387 217 613z m-467-11c-93 0-169-76-169-169s76-169 169-169 169 76 169 169-76 169-169 169z" horiz-adv-x="1000" />
|
||||
|
||||
|
Before Width: | Height: | Size: 24 KiB After Width: | Height: | Size: 25 KiB |
Binary file not shown.
Binary file not shown.
Binary file not shown.
Reference in New Issue
Block a user