mirror/gohugoio-hugo
1
0
Fork 0
mirror of https://github.com/gohugoio/hugo.git synced 2024-05-11 05:54:58 +00:00
Code Issues Releases Activity
Files
d356720f7427a1bd617d3f1a30f7c6498c0e0c37
gohugoio-hugo/docs/content/commands/hugo_check.md

50 lines
1.8 KiB
Markdown
Raw Normal View History

Add gendoc command Using the new, great auto-doc in Cobra. This commit also contains a current result of that command added to a commands section in docs. Fixes #1136
2015-05-13 15:31:30 +02:00
---
Complete the Url-to-URL transition in docs See #959
2015-09-08 23:29:04 -06:00
date: 2015-09-08T22:45:13-06:00
Add gendoc command Using the new, great auto-doc in Cobra. This commit also contains a current result of that command added to a commands section in docs. Fixes #1136
2015-05-13 15:31:30 +02:00
title: "hugo check"
slug: hugo_check
url: /commands/hugo_check/
---
## hugo check
Check content in the source directory
### Synopsis
Improve formatting of Hugo command descriptions Trying to make them look good both in the terminal (`hugo help [command]`) and in the web browser (http://gohugo.io/commands/). :-)
2015-08-04 03:15:12 -06:00
Hugo will perform some basic analysis on the content provided
and will give feedback.
Add gendoc command Using the new, great auto-doc in Cobra. This commit also contains a current result of that command added to a commands section in docs. Fixes #1136
2015-05-13 15:31:30 +02:00
```
hugo check
```
### Options inherited from parent commands
```
Complete the Url-to-URL transition in docs See #959
2015-09-08 23:29:04 -06:00
-b, --baseURL="": hostname (and path) to the root, e.g. http://spf13.com/
Improve formatting of Hugo command descriptions Trying to make them look good both in the terminal (`hugo help [command]`) and in the web browser (http://gohugo.io/commands/). :-)
2015-08-04 03:15:12 -06:00
-D, --buildDrafts[=false]: include content marked as draft
-F, --buildFuture[=false]: include content with publishdate in the future
Add gendoc command Using the new, great auto-doc in Cobra. This commit also contains a current result of that command added to a commands section in docs. Fixes #1136
2015-05-13 15:31:30 +02:00
--cacheDir="": filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/
--config="": config file (default is path/config.yaml|json|toml)
-d, --destination="": filesystem path to write files to
Improve formatting of Hugo command descriptions Trying to make them look good both in the terminal (`hugo help [command]`) and in the web browser (http://gohugo.io/commands/). :-)
2015-08-04 03:15:12 -06:00
--disableRSS[=false]: Do not build RSS files
--disableSitemap[=false]: Do not build Sitemap file
Add gendoc command Using the new, great auto-doc in Cobra. This commit also contains a current result of that command added to a commands section in docs. Fixes #1136
2015-05-13 15:31:30 +02:00
--editor="": edit new content with this editor, if provided
Improve formatting of Hugo command descriptions Trying to make them look good both in the terminal (`hugo help [command]`) and in the web browser (http://gohugo.io/commands/). :-)
2015-08-04 03:15:12 -06:00
--ignoreCache[=false]: Ignores the cache directory for reading but still writes to it
--log[=false]: Enable Logging
Add gendoc command Using the new, great auto-doc in Cobra. This commit also contains a current result of that command added to a commands section in docs. Fixes #1136
2015-05-13 15:31:30 +02:00
--logFile="": Log File path (if set, logging enabled automatically)
Improve formatting of Hugo command descriptions Trying to make them look good both in the terminal (`hugo help [command]`) and in the web browser (http://gohugo.io/commands/). :-)
2015-08-04 03:15:12 -06:00
--pluralizeListTitles[=true]: Pluralize titles in lists using inflect
--preserveTaxonomyNames[=false]: Preserve taxonomy names as written ("Gérard Depardieu" vs "gerard-depardieu")
Add gendoc command Using the new, great auto-doc in Cobra. This commit also contains a current result of that command added to a commands section in docs. Fixes #1136
2015-05-13 15:31:30 +02:00
-s, --source="": filesystem path to read files relative from
Improve formatting of Hugo command descriptions Trying to make them look good both in the terminal (`hugo help [command]`) and in the web browser (http://gohugo.io/commands/). :-)
2015-08-04 03:15:12 -06:00
--stepAnalysis[=false]: display memory and timing of different steps of the program
Add gendoc command Using the new, great auto-doc in Cobra. This commit also contains a current result of that command added to a commands section in docs. Fixes #1136
2015-05-13 15:31:30 +02:00
-t, --theme="": theme to use (located in /themes/THEMENAME/)
Complete the Url-to-URL transition in docs See #959
2015-09-08 23:29:04 -06:00
--uglyURLs[=false]: if true, use /filename.html instead of /filename/
Improve formatting of Hugo command descriptions Trying to make them look good both in the terminal (`hugo help [command]`) and in the web browser (http://gohugo.io/commands/). :-)
2015-08-04 03:15:12 -06:00
-v, --verbose[=false]: verbose output
--verboseLog[=false]: verbose logging
Add gendoc command Using the new, great auto-doc in Cobra. This commit also contains a current result of that command added to a commands section in docs. Fixes #1136
2015-05-13 15:31:30 +02:00
```
### SEE ALSO
Fix CLI command description for the top level And regenerate the commands doc.
2015-05-21 13:30:01 +02:00
* [hugo](/commands/hugo/) - hugo builds your site
Add gendoc command Using the new, great auto-doc in Cobra. This commit also contains a current result of that command added to a commands section in docs. Fixes #1136
2015-05-13 15:31:30 +02:00
Complete the Url-to-URL transition in docs See #959
2015-09-08 23:29:04 -06:00
###### Auto generated by spf13/cobra on 8-Sep-2015
Copy Permalink