phoenix/hugo
1
0
Fork 0
mirror of https://github.com/gohugoio/hugo.git synced 2024-07-02 23:30:00 +00:00
Code Issues Packages Projects Releases Wiki Activity

Do not create robots.txt by default

Browse source 
Meny people, including me, have a custom robots.txt in static.

Also remove that option from the command line; it doesn't feel
important enough.

Fixes ##2049
This commit is contained in:
Bjørn Erik Pedersen 2016-04-05 22:20:39 +02:00
parent 43b5dfabb5
commit 54750b0780
5 changed files with 8 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
commands/hugo.go
View file

@ -126,7 +126,7 @@ var (
buildWatch bool
canonifyURLs bool
cleanDestination bool
disableRobotsTXT bool
enableRobotsTXT bool
disableRSS bool
disableSitemap bool
draft bool
@ -216,7 +216,6 @@ func initHugoBuildCommonFlags(cmd *cobra.Command) {
cmd.Flags().BoolVarP(&future, "buildFuture", "F", false, "include content with publishdate in the future")
cmd.Flags().BoolVar(&disableRSS, "disableRSS", false, "Do not build RSS files")
cmd.Flags().BoolVar(&disableSitemap, "disableSitemap", false, "Do not build Sitemap file")
cmd.Flags().BoolVar(&disableRobotsTXT, "disableRobotsTXT", false, "Do not build Robots TXT file")
cmd.Flags().StringVarP(&source, "source", "s", "", "filesystem path to read files relative from")
cmd.Flags().StringVarP(&contentDir, "contentDir", "c", "", "filesystem path to content directory")
cmd.Flags().StringVarP(&layoutDir, "layoutDir", "l", "", "filesystem path to layout directory")
@ -364,8 +363,8 @@ func InitializeConfig(subCmdVs ...*cobra.Command) error {
if flagChanged(cmdV.Flags(), "disableSitemap") {
viper.Set("DisableSitemap", disableSitemap)
}
if flagChanged(cmdV.Flags(), "disableRobotsTXT") {
viper.Set("DisableRobotsTXT", disableRobotsTXT)
if flagChanged(cmdV.Flags(), "enableRobotsTXT") {
viper.Set("EnableRobotsTXT", enableRobotsTXT)
}
if flagChanged(cmdV.Flags(), "pluralizeListTitles") {
viper.Set("PluralizeListTitles", pluralizeListTitles)

3
docs/content/extras/robots-txt.md
View file

@ -13,13 +13,12 @@ weight: 120
Hugo can generated a customized [robots.txt](http://www.robotstxt.org/) in the
[same way as any other templates]({{< ref "templates/go-templates.md" >}}).
By default, it generates a robots.txt, which allows everything, with the following content:
To enable it, just set `enableRobotsTXT` option to `true` in the [configuration file]({{< ref "overview/configuration.md" >}}). By default, it generates a robots.txt, which allows everything, with the following content:
```http
User-agent: *
```
To disable it, just set `disableRobotsTXT` option to `false` in the [command line]({{< ref "commands/hugo.md" >}}) or [configuration file]({{< ref "overview/configuration.md" >}}).
Hugo will use the template `robots.txt` according to the following list in descending precedence:

4
docs/content/overview/configuration.md
View file

@ -95,8 +95,8 @@ Following is a list of Hugo-defined variables that you can configure and their c
disableRSS: false
# Do not build Sitemap file
disableSitemap: false
# Do not build robots.txt file
disableRobotsTXT: false
# Build robots.txt file
enableRobotsTXT: false
# edit new content with this editor, if provided
editor: ""
# Enable Emoji emoticons support for page content.

1
hugolib/robotstxt_test.go
View file

@ -36,6 +36,7 @@ func TestRobotsTXTOutput(t *testing.T) {
hugofs.InitMemFs()
viper.Set("baseurl", "http://auth/bub/")
viper.Set("enableRobotsTXT", true)
s := &Site{
Source: &source.InMemorySource{ByteSource: WEIGHTED_SOURCES},

2
hugolib/site.go
View file

@ -1864,7 +1864,7 @@ func (s *Site) RenderSitemap() error {
}
func (s *Site) RenderRobotsTXT() error {
if viper.GetBool("DisableRobotsTXT") {
if !viper.GetBool("EnableRobotsTXT") {
return nil
}