From 919e0a75cd3f5fb554999f578fc66b08003f7362 Mon Sep 17 00:00:00 2001 From: Mahmoud Zalt Date: Fri, 14 Apr 2017 14:43:28 -0400 Subject: [PATCH] Delet the _settings folder from the Documentation --- .travis.yml | 4 ++-- DOCUMENTATION/{_settings => }/config.toml | 2 +- .../content/contributing/index.md | 8 ++++---- .../content/documentation/index.md | 0 .../content/getting-started/index.md | 0 .../{_settings => }/content/guides/index.md | 0 .../{_settings => }/content/help/index.md | 0 DOCUMENTATION/{_settings => }/content/index.md | 0 .../content/introduction/index.md | 0 .../{_settings => }/content/license/index.md | 0 .../content/related-projects/index.md | 0 DOCUMENTATION/{_settings => }/static/.gitkeep | 0 DOCUMENTATION/{_settings => }/static/CNAME | 0 .../themes/hugo-material-docs/CHANGELOG.md | 0 .../themes/hugo-material-docs/LICENSE.md | 0 .../themes/hugo-material-docs/README.md | 0 .../hugo-material-docs/archetypes/default.md | 0 .../themes/hugo-material-docs/layouts/404.html | 0 .../layouts/_default/__list.html | 0 .../layouts/_default/single.html | 0 .../hugo-material-docs/layouts/index.html | 0 .../layouts/partials/drawer.html | 0 .../layouts/partials/footer.html | 0 .../layouts/partials/footer_js.html | 0 .../layouts/partials/head.html | 0 .../layouts/partials/header.html | 0 .../layouts/partials/nav.html | 0 .../layouts/partials/nav_link.html | 0 .../layouts/shortcodes/note.html | 0 .../layouts/shortcodes/warning.html | 0 .../hugo-material-docs/static/fonts/icon.eot | Bin .../hugo-material-docs/static/fonts/icon.svg | 0 .../hugo-material-docs/static/fonts/icon.ttf | Bin .../hugo-material-docs/static/fonts/icon.woff | Bin .../hugo-material-docs/static/images/colors.png | Bin .../static/images/favicon.ico | Bin .../hugo-material-docs/static/images/logo.png | Bin .../hugo-material-docs/static/images/screen.png | Bin .../static/javascripts/application.js | 0 .../static/javascripts/modernizr.js | 0 .../static/photos/KiTTY/Connection.png | Bin .../static/photos/KiTTY/ConnectionData.png | Bin .../static/photos/KiTTY/ConnectionSSH.png | Bin .../static/photos/KiTTY/ConnectionSSHAuth.png | Bin .../static/photos/KiTTY/Session.png | Bin .../static/photos/KiTTY/Terminal.png | Bin .../static/photos/KiTTY/TerminalKeyboard.png | Bin .../static/photos/KiTTY/TerminalShell.png | Bin .../static/photos/KiTTY/Window.png | Bin .../static/photos/KiTTY/WindowAppearance.png | Bin .../static/photos/PHPStorm/DebugRemoteOn.png | Bin .../photos/PHPStorm/RemoteDebuggingSuccess.png | Bin .../static/photos/PHPStorm/RemoteHost.png | Bin .../PHPStorm/RemoteTestDebuggingSuccess.png | Bin .../PHPStorm/RemoteWebDebuggingSuccess.png | Bin .../Settings/BuildDeploymentConnection.png | Bin .../BuildDeploymentConnectionMappings.png | Bin .../Settings/BuildDeploymentDebugger.png | Bin ...itRunConfigurationRemoteExampleTestDebug.png | Bin .../EditRunConfigurationRemoteWebDebug.png | Bin .../photos/PHPStorm/Settings/LangsPHPDebug.png | Bin .../PHPStorm/Settings/LangsPHPInterpreters.png | Bin .../PHPStorm/Settings/LangsPHPPHPUnit.png | Bin .../PHPStorm/Settings/LangsPHPServers.png | Bin .../Settings/WindowsFirewallAllowedApps.png | Bin .../PHPStorm/Settings/WindowsHyperVManager.png | Bin .../static/photos/PHPStorm/Settings/hosts.png | Bin .../SimpleHostsEditor/AddHost_laravel.png | Bin .../static/stylesheets/application.css | 0 .../static/stylesheets/highlight/highlight.css | 0 .../static/stylesheets/palettes.css | 0 .../static/stylesheets/temporary.css | 0 .../themes/hugo-material-docs/theme.toml | 0 docs/contributing/index.html | 16 +++++++++++----- docs/contributing/index.xml | 16 +++++++++++----- docs/index.html | 16 +++++++++++----- docs/index.xml | 16 +++++++++++----- 77 files changed, 51 insertions(+), 27 deletions(-) rename DOCUMENTATION/{_settings => }/config.toml (98%) rename DOCUMENTATION/{_settings => }/content/contributing/index.md (93%) rename DOCUMENTATION/{_settings => }/content/documentation/index.md (100%) rename DOCUMENTATION/{_settings => }/content/getting-started/index.md (100%) rename DOCUMENTATION/{_settings => }/content/guides/index.md (100%) rename DOCUMENTATION/{_settings => }/content/help/index.md (100%) rename DOCUMENTATION/{_settings => }/content/index.md (100%) rename DOCUMENTATION/{_settings => }/content/introduction/index.md (100%) rename DOCUMENTATION/{_settings => }/content/license/index.md (100%) rename DOCUMENTATION/{_settings => }/content/related-projects/index.md (100%) rename DOCUMENTATION/{_settings => }/static/.gitkeep (100%) rename DOCUMENTATION/{_settings => }/static/CNAME (100%) rename DOCUMENTATION/{_settings => }/themes/hugo-material-docs/CHANGELOG.md (100%) rename DOCUMENTATION/{_settings => }/themes/hugo-material-docs/LICENSE.md (100%) rename DOCUMENTATION/{_settings => }/themes/hugo-material-docs/README.md (100%) rename DOCUMENTATION/{_settings => }/themes/hugo-material-docs/archetypes/default.md (100%) rename DOCUMENTATION/{_settings => }/themes/hugo-material-docs/layouts/404.html (100%) rename DOCUMENTATION/{_settings => }/themes/hugo-material-docs/layouts/_default/__list.html (100%) rename DOCUMENTATION/{_settings => }/themes/hugo-material-docs/layouts/_default/single.html (100%) rename DOCUMENTATION/{_settings => }/themes/hugo-material-docs/layouts/index.html (100%) rename DOCUMENTATION/{_settings => }/themes/hugo-material-docs/layouts/partials/drawer.html (100%) rename DOCUMENTATION/{_settings => }/themes/hugo-material-docs/layouts/partials/footer.html (100%) rename DOCUMENTATION/{_settings => }/themes/hugo-material-docs/layouts/partials/footer_js.html (100%) rename DOCUMENTATION/{_settings => }/themes/hugo-material-docs/layouts/partials/head.html (100%) rename DOCUMENTATION/{_settings => }/themes/hugo-material-docs/layouts/partials/header.html (100%) rename DOCUMENTATION/{_settings => }/themes/hugo-material-docs/layouts/partials/nav.html (100%) rename DOCUMENTATION/{_settings => }/themes/hugo-material-docs/layouts/partials/nav_link.html (100%) rename DOCUMENTATION/{_settings => }/themes/hugo-material-docs/layouts/shortcodes/note.html (100%) rename DOCUMENTATION/{_settings => }/themes/hugo-material-docs/layouts/shortcodes/warning.html (100%) rename DOCUMENTATION/{_settings => }/themes/hugo-material-docs/static/fonts/icon.eot (100%) rename DOCUMENTATION/{_settings => }/themes/hugo-material-docs/static/fonts/icon.svg (100%) rename DOCUMENTATION/{_settings => }/themes/hugo-material-docs/static/fonts/icon.ttf (100%) rename DOCUMENTATION/{_settings => }/themes/hugo-material-docs/static/fonts/icon.woff (100%) rename DOCUMENTATION/{_settings => }/themes/hugo-material-docs/static/images/colors.png (100%) rename DOCUMENTATION/{_settings => }/themes/hugo-material-docs/static/images/favicon.ico (100%) rename DOCUMENTATION/{_settings => }/themes/hugo-material-docs/static/images/logo.png (100%) rename DOCUMENTATION/{_settings => }/themes/hugo-material-docs/static/images/screen.png (100%) rename DOCUMENTATION/{_settings => }/themes/hugo-material-docs/static/javascripts/application.js (100%) rename DOCUMENTATION/{_settings => }/themes/hugo-material-docs/static/javascripts/modernizr.js (100%) rename DOCUMENTATION/{_settings => }/themes/hugo-material-docs/static/photos/KiTTY/Connection.png (100%) rename DOCUMENTATION/{_settings => }/themes/hugo-material-docs/static/photos/KiTTY/ConnectionData.png (100%) rename DOCUMENTATION/{_settings => }/themes/hugo-material-docs/static/photos/KiTTY/ConnectionSSH.png (100%) rename DOCUMENTATION/{_settings => }/themes/hugo-material-docs/static/photos/KiTTY/ConnectionSSHAuth.png (100%) rename DOCUMENTATION/{_settings => }/themes/hugo-material-docs/static/photos/KiTTY/Session.png (100%) rename DOCUMENTATION/{_settings => }/themes/hugo-material-docs/static/photos/KiTTY/Terminal.png (100%) rename DOCUMENTATION/{_settings => }/themes/hugo-material-docs/static/photos/KiTTY/TerminalKeyboard.png (100%) rename DOCUMENTATION/{_settings => }/themes/hugo-material-docs/static/photos/KiTTY/TerminalShell.png (100%) rename DOCUMENTATION/{_settings => }/themes/hugo-material-docs/static/photos/KiTTY/Window.png (100%) rename DOCUMENTATION/{_settings => }/themes/hugo-material-docs/static/photos/KiTTY/WindowAppearance.png (100%) rename DOCUMENTATION/{_settings => }/themes/hugo-material-docs/static/photos/PHPStorm/DebugRemoteOn.png (100%) rename DOCUMENTATION/{_settings => }/themes/hugo-material-docs/static/photos/PHPStorm/RemoteDebuggingSuccess.png (100%) rename DOCUMENTATION/{_settings => }/themes/hugo-material-docs/static/photos/PHPStorm/RemoteHost.png (100%) rename DOCUMENTATION/{_settings => }/themes/hugo-material-docs/static/photos/PHPStorm/RemoteTestDebuggingSuccess.png (100%) rename DOCUMENTATION/{_settings => }/themes/hugo-material-docs/static/photos/PHPStorm/RemoteWebDebuggingSuccess.png (100%) rename DOCUMENTATION/{_settings => }/themes/hugo-material-docs/static/photos/PHPStorm/Settings/BuildDeploymentConnection.png (100%) rename DOCUMENTATION/{_settings => }/themes/hugo-material-docs/static/photos/PHPStorm/Settings/BuildDeploymentConnectionMappings.png (100%) rename DOCUMENTATION/{_settings => }/themes/hugo-material-docs/static/photos/PHPStorm/Settings/BuildDeploymentDebugger.png (100%) rename DOCUMENTATION/{_settings => }/themes/hugo-material-docs/static/photos/PHPStorm/Settings/EditRunConfigurationRemoteExampleTestDebug.png (100%) rename DOCUMENTATION/{_settings => }/themes/hugo-material-docs/static/photos/PHPStorm/Settings/EditRunConfigurationRemoteWebDebug.png (100%) rename DOCUMENTATION/{_settings => }/themes/hugo-material-docs/static/photos/PHPStorm/Settings/LangsPHPDebug.png (100%) rename DOCUMENTATION/{_settings => }/themes/hugo-material-docs/static/photos/PHPStorm/Settings/LangsPHPInterpreters.png (100%) rename DOCUMENTATION/{_settings => }/themes/hugo-material-docs/static/photos/PHPStorm/Settings/LangsPHPPHPUnit.png (100%) rename DOCUMENTATION/{_settings => }/themes/hugo-material-docs/static/photos/PHPStorm/Settings/LangsPHPServers.png (100%) rename DOCUMENTATION/{_settings => }/themes/hugo-material-docs/static/photos/PHPStorm/Settings/WindowsFirewallAllowedApps.png (100%) rename DOCUMENTATION/{_settings => }/themes/hugo-material-docs/static/photos/PHPStorm/Settings/WindowsHyperVManager.png (100%) rename DOCUMENTATION/{_settings => }/themes/hugo-material-docs/static/photos/PHPStorm/Settings/hosts.png (100%) rename DOCUMENTATION/{_settings => }/themes/hugo-material-docs/static/photos/SimpleHostsEditor/AddHost_laravel.png (100%) rename DOCUMENTATION/{_settings => }/themes/hugo-material-docs/static/stylesheets/application.css (100%) rename DOCUMENTATION/{_settings => }/themes/hugo-material-docs/static/stylesheets/highlight/highlight.css (100%) rename DOCUMENTATION/{_settings => }/themes/hugo-material-docs/static/stylesheets/palettes.css (100%) rename DOCUMENTATION/{_settings => }/themes/hugo-material-docs/static/stylesheets/temporary.css (100%) rename DOCUMENTATION/{_settings => }/themes/hugo-material-docs/theme.toml (100%) diff --git a/.travis.yml b/.travis.yml index 6a8e8c6a..0392b10b 100644 --- a/.travis.yml +++ b/.travis.yml @@ -7,13 +7,13 @@ install: - mv ./hugo_${HUGO_VERSION}_linux_amd64/hugo_${HUGO_VERSION}_linux_amd64 $HOME/bin/hugo script: - rm -rf docs - - cd DOCUMENTATION/_settings + - cd DOCUMENTATION - hugo deploy: provider: pages skip_cleanup: true - local_dir: ../../docs + local_dir: ../docs github_token: $GITHUB_TOKEN on: branch: master diff --git a/DOCUMENTATION/_settings/config.toml b/DOCUMENTATION/config.toml similarity index 98% rename from DOCUMENTATION/_settings/config.toml rename to DOCUMENTATION/config.toml index cffc6063..c075e30f 100644 --- a/DOCUMENTATION/_settings/config.toml +++ b/DOCUMENTATION/config.toml @@ -1,6 +1,6 @@ baseurl = "http://laradock.io/" languageCode = "en-us" -publishDir = "../../docs" +publishDir = "../docs" title = "Laradock" theme = "hugo-material-docs" metadataformat = "yaml" diff --git a/DOCUMENTATION/_settings/content/contributing/index.md b/DOCUMENTATION/content/contributing/index.md similarity index 93% rename from DOCUMENTATION/_settings/content/contributing/index.md rename to DOCUMENTATION/content/contributing/index.md index 00d20f5b..29b66b68 100644 --- a/DOCUMENTATION/_settings/content/contributing/index.md +++ b/DOCUMENTATION/content/contributing/index.md @@ -38,11 +38,11 @@ You can request a new feature by submitting an [Issue](https://github.com/larado Laradock uses [Hugo](https://gohugo.io/) as website generator tool, with the [Material Docs theme](http://themes.gohugo.io/theme/material-docs/). You might need to check their docs quickly. -Go the `DOCUMENTATION/_settings/content` and search for the markdown file you want to edit +Go the `DOCUMENTATION/content` and search for the markdown file you want to edit Note: Every folder represents a section in the sidebar "Menu". And every page and sidebar has a `weight` number to show it's position in the site. -To update the sidebar or add a new section to it, you can edit this `DOCUMENTATION/_settings/config.toml` toml file. +To update the sidebar or add a new section to it, you can edit this `DOCUMENTATION/config.toml` toml file. > The site will be auto-generated in the `docs/` folder by [Travis CI](https://travis-ci.org/laradock/laradock/). @@ -52,9 +52,9 @@ To update the sidebar or add a new section to it, you can edit this `DOCUMENTATI ### To Host the website locally 1. Install [Hugo](https://gohugo.io/) on your machine. -2. Edit the `DOCUMENTATION/_settings/content`. +2. Edit the `DOCUMENTATION/content`. 3. Delete the `/docs` folder from the root. -4. After you finish the editing, go to `DOCUMENTATION/_settings/` and run the `hugo` command to generate the HTML docs (inside a new `/docs` folder). +4. After you finish the editing, go to `DOCUMENTATION/` and run the `hugo` command to generate the HTML docs (inside a new `/docs` folder). diff --git a/DOCUMENTATION/_settings/content/documentation/index.md b/DOCUMENTATION/content/documentation/index.md similarity index 100% rename from DOCUMENTATION/_settings/content/documentation/index.md rename to DOCUMENTATION/content/documentation/index.md diff --git a/DOCUMENTATION/_settings/content/getting-started/index.md b/DOCUMENTATION/content/getting-started/index.md similarity index 100% rename from DOCUMENTATION/_settings/content/getting-started/index.md rename to DOCUMENTATION/content/getting-started/index.md diff --git a/DOCUMENTATION/_settings/content/guides/index.md b/DOCUMENTATION/content/guides/index.md similarity index 100% rename from DOCUMENTATION/_settings/content/guides/index.md rename to DOCUMENTATION/content/guides/index.md diff --git a/DOCUMENTATION/_settings/content/help/index.md b/DOCUMENTATION/content/help/index.md similarity index 100% rename from DOCUMENTATION/_settings/content/help/index.md rename to DOCUMENTATION/content/help/index.md diff --git a/DOCUMENTATION/_settings/content/index.md b/DOCUMENTATION/content/index.md similarity index 100% rename from DOCUMENTATION/_settings/content/index.md rename to DOCUMENTATION/content/index.md diff --git a/DOCUMENTATION/_settings/content/introduction/index.md b/DOCUMENTATION/content/introduction/index.md similarity index 100% rename from DOCUMENTATION/_settings/content/introduction/index.md rename to DOCUMENTATION/content/introduction/index.md diff --git a/DOCUMENTATION/_settings/content/license/index.md b/DOCUMENTATION/content/license/index.md similarity index 100% rename from DOCUMENTATION/_settings/content/license/index.md rename to DOCUMENTATION/content/license/index.md diff --git a/DOCUMENTATION/_settings/content/related-projects/index.md b/DOCUMENTATION/content/related-projects/index.md similarity index 100% rename from DOCUMENTATION/_settings/content/related-projects/index.md rename to DOCUMENTATION/content/related-projects/index.md diff --git a/DOCUMENTATION/_settings/static/.gitkeep b/DOCUMENTATION/static/.gitkeep similarity index 100% rename from DOCUMENTATION/_settings/static/.gitkeep rename to DOCUMENTATION/static/.gitkeep diff --git a/DOCUMENTATION/_settings/static/CNAME b/DOCUMENTATION/static/CNAME similarity index 100% rename from DOCUMENTATION/_settings/static/CNAME rename to DOCUMENTATION/static/CNAME diff --git a/DOCUMENTATION/_settings/themes/hugo-material-docs/CHANGELOG.md b/DOCUMENTATION/themes/hugo-material-docs/CHANGELOG.md similarity index 100% rename from DOCUMENTATION/_settings/themes/hugo-material-docs/CHANGELOG.md rename to DOCUMENTATION/themes/hugo-material-docs/CHANGELOG.md diff --git a/DOCUMENTATION/_settings/themes/hugo-material-docs/LICENSE.md b/DOCUMENTATION/themes/hugo-material-docs/LICENSE.md similarity index 100% rename from DOCUMENTATION/_settings/themes/hugo-material-docs/LICENSE.md rename to DOCUMENTATION/themes/hugo-material-docs/LICENSE.md diff --git a/DOCUMENTATION/_settings/themes/hugo-material-docs/README.md b/DOCUMENTATION/themes/hugo-material-docs/README.md similarity index 100% rename from DOCUMENTATION/_settings/themes/hugo-material-docs/README.md rename to DOCUMENTATION/themes/hugo-material-docs/README.md diff --git a/DOCUMENTATION/_settings/themes/hugo-material-docs/archetypes/default.md b/DOCUMENTATION/themes/hugo-material-docs/archetypes/default.md similarity index 100% rename from DOCUMENTATION/_settings/themes/hugo-material-docs/archetypes/default.md rename to DOCUMENTATION/themes/hugo-material-docs/archetypes/default.md diff --git a/DOCUMENTATION/_settings/themes/hugo-material-docs/layouts/404.html b/DOCUMENTATION/themes/hugo-material-docs/layouts/404.html similarity index 100% rename from DOCUMENTATION/_settings/themes/hugo-material-docs/layouts/404.html rename to DOCUMENTATION/themes/hugo-material-docs/layouts/404.html diff --git a/DOCUMENTATION/_settings/themes/hugo-material-docs/layouts/_default/__list.html b/DOCUMENTATION/themes/hugo-material-docs/layouts/_default/__list.html similarity index 100% rename from DOCUMENTATION/_settings/themes/hugo-material-docs/layouts/_default/__list.html rename to DOCUMENTATION/themes/hugo-material-docs/layouts/_default/__list.html diff --git a/DOCUMENTATION/_settings/themes/hugo-material-docs/layouts/_default/single.html b/DOCUMENTATION/themes/hugo-material-docs/layouts/_default/single.html similarity index 100% rename from DOCUMENTATION/_settings/themes/hugo-material-docs/layouts/_default/single.html rename to DOCUMENTATION/themes/hugo-material-docs/layouts/_default/single.html diff --git a/DOCUMENTATION/_settings/themes/hugo-material-docs/layouts/index.html b/DOCUMENTATION/themes/hugo-material-docs/layouts/index.html similarity index 100% rename from DOCUMENTATION/_settings/themes/hugo-material-docs/layouts/index.html rename to DOCUMENTATION/themes/hugo-material-docs/layouts/index.html diff --git a/DOCUMENTATION/_settings/themes/hugo-material-docs/layouts/partials/drawer.html b/DOCUMENTATION/themes/hugo-material-docs/layouts/partials/drawer.html similarity index 100% rename from DOCUMENTATION/_settings/themes/hugo-material-docs/layouts/partials/drawer.html rename to DOCUMENTATION/themes/hugo-material-docs/layouts/partials/drawer.html diff --git a/DOCUMENTATION/_settings/themes/hugo-material-docs/layouts/partials/footer.html b/DOCUMENTATION/themes/hugo-material-docs/layouts/partials/footer.html similarity index 100% rename from DOCUMENTATION/_settings/themes/hugo-material-docs/layouts/partials/footer.html rename to DOCUMENTATION/themes/hugo-material-docs/layouts/partials/footer.html diff --git a/DOCUMENTATION/_settings/themes/hugo-material-docs/layouts/partials/footer_js.html b/DOCUMENTATION/themes/hugo-material-docs/layouts/partials/footer_js.html similarity index 100% rename from DOCUMENTATION/_settings/themes/hugo-material-docs/layouts/partials/footer_js.html rename to DOCUMENTATION/themes/hugo-material-docs/layouts/partials/footer_js.html diff --git a/DOCUMENTATION/_settings/themes/hugo-material-docs/layouts/partials/head.html b/DOCUMENTATION/themes/hugo-material-docs/layouts/partials/head.html similarity index 100% rename from DOCUMENTATION/_settings/themes/hugo-material-docs/layouts/partials/head.html rename to DOCUMENTATION/themes/hugo-material-docs/layouts/partials/head.html diff --git a/DOCUMENTATION/_settings/themes/hugo-material-docs/layouts/partials/header.html b/DOCUMENTATION/themes/hugo-material-docs/layouts/partials/header.html similarity index 100% rename from DOCUMENTATION/_settings/themes/hugo-material-docs/layouts/partials/header.html rename to DOCUMENTATION/themes/hugo-material-docs/layouts/partials/header.html diff --git a/DOCUMENTATION/_settings/themes/hugo-material-docs/layouts/partials/nav.html b/DOCUMENTATION/themes/hugo-material-docs/layouts/partials/nav.html similarity index 100% rename from DOCUMENTATION/_settings/themes/hugo-material-docs/layouts/partials/nav.html rename to DOCUMENTATION/themes/hugo-material-docs/layouts/partials/nav.html diff --git a/DOCUMENTATION/_settings/themes/hugo-material-docs/layouts/partials/nav_link.html b/DOCUMENTATION/themes/hugo-material-docs/layouts/partials/nav_link.html similarity index 100% rename from DOCUMENTATION/_settings/themes/hugo-material-docs/layouts/partials/nav_link.html rename to DOCUMENTATION/themes/hugo-material-docs/layouts/partials/nav_link.html diff --git a/DOCUMENTATION/_settings/themes/hugo-material-docs/layouts/shortcodes/note.html b/DOCUMENTATION/themes/hugo-material-docs/layouts/shortcodes/note.html similarity index 100% rename from DOCUMENTATION/_settings/themes/hugo-material-docs/layouts/shortcodes/note.html rename to DOCUMENTATION/themes/hugo-material-docs/layouts/shortcodes/note.html diff --git a/DOCUMENTATION/_settings/themes/hugo-material-docs/layouts/shortcodes/warning.html b/DOCUMENTATION/themes/hugo-material-docs/layouts/shortcodes/warning.html similarity index 100% rename from DOCUMENTATION/_settings/themes/hugo-material-docs/layouts/shortcodes/warning.html rename to DOCUMENTATION/themes/hugo-material-docs/layouts/shortcodes/warning.html diff --git a/DOCUMENTATION/_settings/themes/hugo-material-docs/static/fonts/icon.eot b/DOCUMENTATION/themes/hugo-material-docs/static/fonts/icon.eot similarity index 100% rename from DOCUMENTATION/_settings/themes/hugo-material-docs/static/fonts/icon.eot rename to DOCUMENTATION/themes/hugo-material-docs/static/fonts/icon.eot diff --git a/DOCUMENTATION/_settings/themes/hugo-material-docs/static/fonts/icon.svg b/DOCUMENTATION/themes/hugo-material-docs/static/fonts/icon.svg similarity index 100% rename from DOCUMENTATION/_settings/themes/hugo-material-docs/static/fonts/icon.svg rename to DOCUMENTATION/themes/hugo-material-docs/static/fonts/icon.svg diff --git a/DOCUMENTATION/_settings/themes/hugo-material-docs/static/fonts/icon.ttf b/DOCUMENTATION/themes/hugo-material-docs/static/fonts/icon.ttf similarity index 100% rename from DOCUMENTATION/_settings/themes/hugo-material-docs/static/fonts/icon.ttf rename to DOCUMENTATION/themes/hugo-material-docs/static/fonts/icon.ttf diff --git a/DOCUMENTATION/_settings/themes/hugo-material-docs/static/fonts/icon.woff b/DOCUMENTATION/themes/hugo-material-docs/static/fonts/icon.woff similarity index 100% rename from DOCUMENTATION/_settings/themes/hugo-material-docs/static/fonts/icon.woff rename to DOCUMENTATION/themes/hugo-material-docs/static/fonts/icon.woff diff --git a/DOCUMENTATION/_settings/themes/hugo-material-docs/static/images/colors.png b/DOCUMENTATION/themes/hugo-material-docs/static/images/colors.png similarity index 100% rename from DOCUMENTATION/_settings/themes/hugo-material-docs/static/images/colors.png rename to DOCUMENTATION/themes/hugo-material-docs/static/images/colors.png diff --git a/DOCUMENTATION/_settings/themes/hugo-material-docs/static/images/favicon.ico b/DOCUMENTATION/themes/hugo-material-docs/static/images/favicon.ico similarity index 100% rename from DOCUMENTATION/_settings/themes/hugo-material-docs/static/images/favicon.ico rename to DOCUMENTATION/themes/hugo-material-docs/static/images/favicon.ico diff --git a/DOCUMENTATION/_settings/themes/hugo-material-docs/static/images/logo.png b/DOCUMENTATION/themes/hugo-material-docs/static/images/logo.png similarity index 100% rename from DOCUMENTATION/_settings/themes/hugo-material-docs/static/images/logo.png rename to DOCUMENTATION/themes/hugo-material-docs/static/images/logo.png diff --git a/DOCUMENTATION/_settings/themes/hugo-material-docs/static/images/screen.png b/DOCUMENTATION/themes/hugo-material-docs/static/images/screen.png similarity index 100% rename from DOCUMENTATION/_settings/themes/hugo-material-docs/static/images/screen.png rename to DOCUMENTATION/themes/hugo-material-docs/static/images/screen.png diff --git a/DOCUMENTATION/_settings/themes/hugo-material-docs/static/javascripts/application.js b/DOCUMENTATION/themes/hugo-material-docs/static/javascripts/application.js similarity index 100% rename from DOCUMENTATION/_settings/themes/hugo-material-docs/static/javascripts/application.js rename to DOCUMENTATION/themes/hugo-material-docs/static/javascripts/application.js diff --git a/DOCUMENTATION/_settings/themes/hugo-material-docs/static/javascripts/modernizr.js b/DOCUMENTATION/themes/hugo-material-docs/static/javascripts/modernizr.js similarity index 100% rename from DOCUMENTATION/_settings/themes/hugo-material-docs/static/javascripts/modernizr.js rename to DOCUMENTATION/themes/hugo-material-docs/static/javascripts/modernizr.js diff --git a/DOCUMENTATION/_settings/themes/hugo-material-docs/static/photos/KiTTY/Connection.png b/DOCUMENTATION/themes/hugo-material-docs/static/photos/KiTTY/Connection.png similarity index 100% rename from DOCUMENTATION/_settings/themes/hugo-material-docs/static/photos/KiTTY/Connection.png rename to DOCUMENTATION/themes/hugo-material-docs/static/photos/KiTTY/Connection.png diff --git a/DOCUMENTATION/_settings/themes/hugo-material-docs/static/photos/KiTTY/ConnectionData.png b/DOCUMENTATION/themes/hugo-material-docs/static/photos/KiTTY/ConnectionData.png similarity index 100% rename from DOCUMENTATION/_settings/themes/hugo-material-docs/static/photos/KiTTY/ConnectionData.png rename to DOCUMENTATION/themes/hugo-material-docs/static/photos/KiTTY/ConnectionData.png diff --git a/DOCUMENTATION/_settings/themes/hugo-material-docs/static/photos/KiTTY/ConnectionSSH.png b/DOCUMENTATION/themes/hugo-material-docs/static/photos/KiTTY/ConnectionSSH.png similarity index 100% rename from DOCUMENTATION/_settings/themes/hugo-material-docs/static/photos/KiTTY/ConnectionSSH.png rename to DOCUMENTATION/themes/hugo-material-docs/static/photos/KiTTY/ConnectionSSH.png diff --git a/DOCUMENTATION/_settings/themes/hugo-material-docs/static/photos/KiTTY/ConnectionSSHAuth.png b/DOCUMENTATION/themes/hugo-material-docs/static/photos/KiTTY/ConnectionSSHAuth.png similarity index 100% rename from DOCUMENTATION/_settings/themes/hugo-material-docs/static/photos/KiTTY/ConnectionSSHAuth.png rename to DOCUMENTATION/themes/hugo-material-docs/static/photos/KiTTY/ConnectionSSHAuth.png diff --git a/DOCUMENTATION/_settings/themes/hugo-material-docs/static/photos/KiTTY/Session.png b/DOCUMENTATION/themes/hugo-material-docs/static/photos/KiTTY/Session.png similarity index 100% rename from DOCUMENTATION/_settings/themes/hugo-material-docs/static/photos/KiTTY/Session.png rename to DOCUMENTATION/themes/hugo-material-docs/static/photos/KiTTY/Session.png diff --git a/DOCUMENTATION/_settings/themes/hugo-material-docs/static/photos/KiTTY/Terminal.png b/DOCUMENTATION/themes/hugo-material-docs/static/photos/KiTTY/Terminal.png similarity index 100% rename from DOCUMENTATION/_settings/themes/hugo-material-docs/static/photos/KiTTY/Terminal.png rename to DOCUMENTATION/themes/hugo-material-docs/static/photos/KiTTY/Terminal.png diff --git a/DOCUMENTATION/_settings/themes/hugo-material-docs/static/photos/KiTTY/TerminalKeyboard.png b/DOCUMENTATION/themes/hugo-material-docs/static/photos/KiTTY/TerminalKeyboard.png similarity index 100% rename from DOCUMENTATION/_settings/themes/hugo-material-docs/static/photos/KiTTY/TerminalKeyboard.png rename to DOCUMENTATION/themes/hugo-material-docs/static/photos/KiTTY/TerminalKeyboard.png diff --git a/DOCUMENTATION/_settings/themes/hugo-material-docs/static/photos/KiTTY/TerminalShell.png b/DOCUMENTATION/themes/hugo-material-docs/static/photos/KiTTY/TerminalShell.png similarity index 100% rename from DOCUMENTATION/_settings/themes/hugo-material-docs/static/photos/KiTTY/TerminalShell.png rename to DOCUMENTATION/themes/hugo-material-docs/static/photos/KiTTY/TerminalShell.png diff --git a/DOCUMENTATION/_settings/themes/hugo-material-docs/static/photos/KiTTY/Window.png b/DOCUMENTATION/themes/hugo-material-docs/static/photos/KiTTY/Window.png similarity index 100% rename from DOCUMENTATION/_settings/themes/hugo-material-docs/static/photos/KiTTY/Window.png rename to DOCUMENTATION/themes/hugo-material-docs/static/photos/KiTTY/Window.png diff --git a/DOCUMENTATION/_settings/themes/hugo-material-docs/static/photos/KiTTY/WindowAppearance.png b/DOCUMENTATION/themes/hugo-material-docs/static/photos/KiTTY/WindowAppearance.png similarity index 100% rename from DOCUMENTATION/_settings/themes/hugo-material-docs/static/photos/KiTTY/WindowAppearance.png rename to DOCUMENTATION/themes/hugo-material-docs/static/photos/KiTTY/WindowAppearance.png diff --git a/DOCUMENTATION/_settings/themes/hugo-material-docs/static/photos/PHPStorm/DebugRemoteOn.png b/DOCUMENTATION/themes/hugo-material-docs/static/photos/PHPStorm/DebugRemoteOn.png similarity index 100% rename from DOCUMENTATION/_settings/themes/hugo-material-docs/static/photos/PHPStorm/DebugRemoteOn.png rename to DOCUMENTATION/themes/hugo-material-docs/static/photos/PHPStorm/DebugRemoteOn.png diff --git a/DOCUMENTATION/_settings/themes/hugo-material-docs/static/photos/PHPStorm/RemoteDebuggingSuccess.png b/DOCUMENTATION/themes/hugo-material-docs/static/photos/PHPStorm/RemoteDebuggingSuccess.png similarity index 100% rename from DOCUMENTATION/_settings/themes/hugo-material-docs/static/photos/PHPStorm/RemoteDebuggingSuccess.png rename to DOCUMENTATION/themes/hugo-material-docs/static/photos/PHPStorm/RemoteDebuggingSuccess.png diff --git a/DOCUMENTATION/_settings/themes/hugo-material-docs/static/photos/PHPStorm/RemoteHost.png b/DOCUMENTATION/themes/hugo-material-docs/static/photos/PHPStorm/RemoteHost.png similarity index 100% rename from DOCUMENTATION/_settings/themes/hugo-material-docs/static/photos/PHPStorm/RemoteHost.png rename to DOCUMENTATION/themes/hugo-material-docs/static/photos/PHPStorm/RemoteHost.png diff --git a/DOCUMENTATION/_settings/themes/hugo-material-docs/static/photos/PHPStorm/RemoteTestDebuggingSuccess.png b/DOCUMENTATION/themes/hugo-material-docs/static/photos/PHPStorm/RemoteTestDebuggingSuccess.png similarity index 100% rename from DOCUMENTATION/_settings/themes/hugo-material-docs/static/photos/PHPStorm/RemoteTestDebuggingSuccess.png rename to DOCUMENTATION/themes/hugo-material-docs/static/photos/PHPStorm/RemoteTestDebuggingSuccess.png diff --git a/DOCUMENTATION/_settings/themes/hugo-material-docs/static/photos/PHPStorm/RemoteWebDebuggingSuccess.png b/DOCUMENTATION/themes/hugo-material-docs/static/photos/PHPStorm/RemoteWebDebuggingSuccess.png similarity index 100% rename from DOCUMENTATION/_settings/themes/hugo-material-docs/static/photos/PHPStorm/RemoteWebDebuggingSuccess.png rename to DOCUMENTATION/themes/hugo-material-docs/static/photos/PHPStorm/RemoteWebDebuggingSuccess.png diff --git a/DOCUMENTATION/_settings/themes/hugo-material-docs/static/photos/PHPStorm/Settings/BuildDeploymentConnection.png b/DOCUMENTATION/themes/hugo-material-docs/static/photos/PHPStorm/Settings/BuildDeploymentConnection.png similarity index 100% rename from DOCUMENTATION/_settings/themes/hugo-material-docs/static/photos/PHPStorm/Settings/BuildDeploymentConnection.png rename to DOCUMENTATION/themes/hugo-material-docs/static/photos/PHPStorm/Settings/BuildDeploymentConnection.png diff --git a/DOCUMENTATION/_settings/themes/hugo-material-docs/static/photos/PHPStorm/Settings/BuildDeploymentConnectionMappings.png b/DOCUMENTATION/themes/hugo-material-docs/static/photos/PHPStorm/Settings/BuildDeploymentConnectionMappings.png similarity index 100% rename from DOCUMENTATION/_settings/themes/hugo-material-docs/static/photos/PHPStorm/Settings/BuildDeploymentConnectionMappings.png rename to DOCUMENTATION/themes/hugo-material-docs/static/photos/PHPStorm/Settings/BuildDeploymentConnectionMappings.png diff --git a/DOCUMENTATION/_settings/themes/hugo-material-docs/static/photos/PHPStorm/Settings/BuildDeploymentDebugger.png b/DOCUMENTATION/themes/hugo-material-docs/static/photos/PHPStorm/Settings/BuildDeploymentDebugger.png similarity index 100% rename from DOCUMENTATION/_settings/themes/hugo-material-docs/static/photos/PHPStorm/Settings/BuildDeploymentDebugger.png rename to DOCUMENTATION/themes/hugo-material-docs/static/photos/PHPStorm/Settings/BuildDeploymentDebugger.png diff --git a/DOCUMENTATION/_settings/themes/hugo-material-docs/static/photos/PHPStorm/Settings/EditRunConfigurationRemoteExampleTestDebug.png b/DOCUMENTATION/themes/hugo-material-docs/static/photos/PHPStorm/Settings/EditRunConfigurationRemoteExampleTestDebug.png similarity index 100% rename from DOCUMENTATION/_settings/themes/hugo-material-docs/static/photos/PHPStorm/Settings/EditRunConfigurationRemoteExampleTestDebug.png rename to DOCUMENTATION/themes/hugo-material-docs/static/photos/PHPStorm/Settings/EditRunConfigurationRemoteExampleTestDebug.png diff --git a/DOCUMENTATION/_settings/themes/hugo-material-docs/static/photos/PHPStorm/Settings/EditRunConfigurationRemoteWebDebug.png b/DOCUMENTATION/themes/hugo-material-docs/static/photos/PHPStorm/Settings/EditRunConfigurationRemoteWebDebug.png similarity index 100% rename from DOCUMENTATION/_settings/themes/hugo-material-docs/static/photos/PHPStorm/Settings/EditRunConfigurationRemoteWebDebug.png rename to DOCUMENTATION/themes/hugo-material-docs/static/photos/PHPStorm/Settings/EditRunConfigurationRemoteWebDebug.png diff --git a/DOCUMENTATION/_settings/themes/hugo-material-docs/static/photos/PHPStorm/Settings/LangsPHPDebug.png b/DOCUMENTATION/themes/hugo-material-docs/static/photos/PHPStorm/Settings/LangsPHPDebug.png similarity index 100% rename from DOCUMENTATION/_settings/themes/hugo-material-docs/static/photos/PHPStorm/Settings/LangsPHPDebug.png rename to DOCUMENTATION/themes/hugo-material-docs/static/photos/PHPStorm/Settings/LangsPHPDebug.png diff --git a/DOCUMENTATION/_settings/themes/hugo-material-docs/static/photos/PHPStorm/Settings/LangsPHPInterpreters.png b/DOCUMENTATION/themes/hugo-material-docs/static/photos/PHPStorm/Settings/LangsPHPInterpreters.png similarity index 100% rename from DOCUMENTATION/_settings/themes/hugo-material-docs/static/photos/PHPStorm/Settings/LangsPHPInterpreters.png rename to DOCUMENTATION/themes/hugo-material-docs/static/photos/PHPStorm/Settings/LangsPHPInterpreters.png diff --git a/DOCUMENTATION/_settings/themes/hugo-material-docs/static/photos/PHPStorm/Settings/LangsPHPPHPUnit.png b/DOCUMENTATION/themes/hugo-material-docs/static/photos/PHPStorm/Settings/LangsPHPPHPUnit.png similarity index 100% rename from DOCUMENTATION/_settings/themes/hugo-material-docs/static/photos/PHPStorm/Settings/LangsPHPPHPUnit.png rename to DOCUMENTATION/themes/hugo-material-docs/static/photos/PHPStorm/Settings/LangsPHPPHPUnit.png diff --git a/DOCUMENTATION/_settings/themes/hugo-material-docs/static/photos/PHPStorm/Settings/LangsPHPServers.png b/DOCUMENTATION/themes/hugo-material-docs/static/photos/PHPStorm/Settings/LangsPHPServers.png similarity index 100% rename from DOCUMENTATION/_settings/themes/hugo-material-docs/static/photos/PHPStorm/Settings/LangsPHPServers.png rename to DOCUMENTATION/themes/hugo-material-docs/static/photos/PHPStorm/Settings/LangsPHPServers.png diff --git a/DOCUMENTATION/_settings/themes/hugo-material-docs/static/photos/PHPStorm/Settings/WindowsFirewallAllowedApps.png b/DOCUMENTATION/themes/hugo-material-docs/static/photos/PHPStorm/Settings/WindowsFirewallAllowedApps.png similarity index 100% rename from DOCUMENTATION/_settings/themes/hugo-material-docs/static/photos/PHPStorm/Settings/WindowsFirewallAllowedApps.png rename to DOCUMENTATION/themes/hugo-material-docs/static/photos/PHPStorm/Settings/WindowsFirewallAllowedApps.png diff --git a/DOCUMENTATION/_settings/themes/hugo-material-docs/static/photos/PHPStorm/Settings/WindowsHyperVManager.png b/DOCUMENTATION/themes/hugo-material-docs/static/photos/PHPStorm/Settings/WindowsHyperVManager.png similarity index 100% rename from DOCUMENTATION/_settings/themes/hugo-material-docs/static/photos/PHPStorm/Settings/WindowsHyperVManager.png rename to DOCUMENTATION/themes/hugo-material-docs/static/photos/PHPStorm/Settings/WindowsHyperVManager.png diff --git a/DOCUMENTATION/_settings/themes/hugo-material-docs/static/photos/PHPStorm/Settings/hosts.png b/DOCUMENTATION/themes/hugo-material-docs/static/photos/PHPStorm/Settings/hosts.png similarity index 100% rename from DOCUMENTATION/_settings/themes/hugo-material-docs/static/photos/PHPStorm/Settings/hosts.png rename to DOCUMENTATION/themes/hugo-material-docs/static/photos/PHPStorm/Settings/hosts.png diff --git a/DOCUMENTATION/_settings/themes/hugo-material-docs/static/photos/SimpleHostsEditor/AddHost_laravel.png b/DOCUMENTATION/themes/hugo-material-docs/static/photos/SimpleHostsEditor/AddHost_laravel.png similarity index 100% rename from DOCUMENTATION/_settings/themes/hugo-material-docs/static/photos/SimpleHostsEditor/AddHost_laravel.png rename to DOCUMENTATION/themes/hugo-material-docs/static/photos/SimpleHostsEditor/AddHost_laravel.png diff --git a/DOCUMENTATION/_settings/themes/hugo-material-docs/static/stylesheets/application.css b/DOCUMENTATION/themes/hugo-material-docs/static/stylesheets/application.css similarity index 100% rename from DOCUMENTATION/_settings/themes/hugo-material-docs/static/stylesheets/application.css rename to DOCUMENTATION/themes/hugo-material-docs/static/stylesheets/application.css diff --git a/DOCUMENTATION/_settings/themes/hugo-material-docs/static/stylesheets/highlight/highlight.css b/DOCUMENTATION/themes/hugo-material-docs/static/stylesheets/highlight/highlight.css similarity index 100% rename from DOCUMENTATION/_settings/themes/hugo-material-docs/static/stylesheets/highlight/highlight.css rename to DOCUMENTATION/themes/hugo-material-docs/static/stylesheets/highlight/highlight.css diff --git a/DOCUMENTATION/_settings/themes/hugo-material-docs/static/stylesheets/palettes.css b/DOCUMENTATION/themes/hugo-material-docs/static/stylesheets/palettes.css similarity index 100% rename from DOCUMENTATION/_settings/themes/hugo-material-docs/static/stylesheets/palettes.css rename to DOCUMENTATION/themes/hugo-material-docs/static/stylesheets/palettes.css diff --git a/DOCUMENTATION/_settings/themes/hugo-material-docs/static/stylesheets/temporary.css b/DOCUMENTATION/themes/hugo-material-docs/static/stylesheets/temporary.css similarity index 100% rename from DOCUMENTATION/_settings/themes/hugo-material-docs/static/stylesheets/temporary.css rename to DOCUMENTATION/themes/hugo-material-docs/static/stylesheets/temporary.css diff --git a/DOCUMENTATION/_settings/themes/hugo-material-docs/theme.toml b/DOCUMENTATION/themes/hugo-material-docs/theme.toml similarity index 100% rename from DOCUMENTATION/_settings/themes/hugo-material-docs/theme.toml rename to DOCUMENTATION/themes/hugo-material-docs/theme.toml diff --git a/docs/contributing/index.html b/docs/contributing/index.html index c081df3e..00e96427 100644 --- a/docs/contributing/index.html +++ b/docs/contributing/index.html @@ -363,19 +363,25 @@ features, by not reporting duplicate issues.

Laradock uses Hugo as website generator tool, with the Material Docs theme. You might need to check their docs quickly.

-

Go the DOCUMENTATION/_settings/content and search for the markdown file you want to edit (every folder represents a section in the menu).

+

Go the DOCUMENTATION/_settings/content and search for the markdown file you want to edit

-

To edit the sidebar or add a new section, you need to edit this file DOCUMENTATION/_settings/config.toml as well.

+

Note: Every folder represents a section in the sidebar “Menu”. And every page and sidebar has a weight number to show it’s position in the site.

-

The site will be autogenerated in the docs/ folder by Travis.

+

To update the sidebar or add a new section to it, you can edit this DOCUMENTATION/_settings/config.toml toml file.

+ +
+

The site will be auto-generated in the docs/ folder by Travis CI.

+
+ +


To Host the website locally

    -
  1. Install Hugo on your machine (easy thing).
    2. +
  2. Install Hugo on your machine.
  3. Edit the DOCUMENTATION/_settings/content.
  4. Delete the /docs folder from the root.
    5. -
  5. When you finish editing, go to DOCUMENTATION/_settings/ and run the hugo command to generate the HTML docs (inside new /docs folder).
    6. +
  6. After you finish the editing, go to DOCUMENTATION/_settings/ and run the hugo command to generate the HTML docs (inside a new /docs folder).

How to support new Software (Add new Container)

diff --git a/docs/contributing/index.xml b/docs/contributing/index.xml index 9ba042e7..29db70f1 100644 --- a/docs/contributing/index.xml +++ b/docs/contributing/index.xml @@ -48,19 +48,25 @@ features, by not reporting duplicate issues.</em></p> <p>Laradock uses <a href="https://gohugo.io/">Hugo</a> as website generator tool, with the <a href="http://themes.gohugo.io/theme/material-docs/">Material Docs theme</a>. You might need to check their docs quickly.</p> -<p>Go the <code>DOCUMENTATION/_settings/content</code> and search for the markdown file you want to edit (every folder represents a section in the menu).</p> +<p>Go the <code>DOCUMENTATION/_settings/content</code> and search for the markdown file you want to edit</p> -<p>To edit the sidebar or add a new section, you need to edit this file <code>DOCUMENTATION/_settings/config.toml</code> as well.</p> +<p>Note: Every folder represents a section in the sidebar &ldquo;Menu&rdquo;. And every page and sidebar has a <code>weight</code> number to show it&rsquo;s position in the site.</p> -<p><em>The site will be autogenerated in the <code>docs/</code> folder by <a href="https://travis-ci.com/">Travis</a>.</em></p> +<p>To update the sidebar or add a new section to it, you can edit this <code>DOCUMENTATION/_settings/config.toml</code> toml file.</p> + +<blockquote> +<p>The site will be auto-generated in the <code>docs/</code> folder by <a href="https://travis-ci.org/laradock/laradock/">Travis CI</a>.</p> +</blockquote> + +<p><br></p> <h3 id="to-host-the-website-locally">To Host the website locally</h3> <ol> -<li>Install <a href="https://gohugo.io/">Hugo</a> on your machine (easy thing).</li> +<li>Install <a href="https://gohugo.io/">Hugo</a> on your machine.</li> <li>Edit the <code>DOCUMENTATION/_settings/content</code>.</li> <li>Delete the <code>/docs</code> folder from the root.</li> -<li>When you finish editing, go to <code>DOCUMENTATION/_settings/</code> and run the <code>hugo</code> command to generate the HTML docs (inside new <code>/docs</code> folder).</li> +<li>After you finish the editing, go to <code>DOCUMENTATION/_settings/</code> and run the <code>hugo</code> command to generate the HTML docs (inside a new <code>/docs</code> folder).</li> </ol> <h2 id="how-to-support-new-software-add-new-container">How to support new Software (Add new Container)</h2> diff --git a/docs/index.html b/docs/index.html index 3dd9ba90..40713c12 100644 --- a/docs/index.html +++ b/docs/index.html @@ -2697,19 +2697,25 @@ features, by not reporting duplicate issues.

Laradock uses Hugo as website generator tool, with the Material Docs theme. You might need to check their docs quickly.

-

Go the DOCUMENTATION/_settings/content and search for the markdown file you want to edit (every folder represents a section in the menu).

+

Go the DOCUMENTATION/_settings/content and search for the markdown file you want to edit

-

To edit the sidebar or add a new section, you need to edit this file DOCUMENTATION/_settings/config.toml as well.

+

Note: Every folder represents a section in the sidebar “Menu”. And every page and sidebar has a weight number to show it’s position in the site.

-

The site will be autogenerated in the docs/ folder by Travis.

+

To update the sidebar or add a new section to it, you can edit this DOCUMENTATION/_settings/config.toml toml file.

+ +
+

The site will be auto-generated in the docs/ folder by Travis CI.

+
+ +


To Host the website locally

    -
  1. Install Hugo on your machine (easy thing).
    2. +
  2. Install Hugo on your machine.
  3. Edit the DOCUMENTATION/_settings/content.
  4. Delete the /docs folder from the root.
    5. -
  5. When you finish editing, go to DOCUMENTATION/_settings/ and run the hugo command to generate the HTML docs (inside new /docs folder).
    6. +
  6. After you finish the editing, go to DOCUMENTATION/_settings/ and run the hugo command to generate the HTML docs (inside a new /docs folder).

How to support new Software (Add new Container)

diff --git a/docs/index.xml b/docs/index.xml index 591088f0..904c387a 100644 --- a/docs/index.xml +++ b/docs/index.xml @@ -2411,19 +2411,25 @@ features, by not reporting duplicate issues.</em></p> <p>Laradock uses <a href="https://gohugo.io/">Hugo</a> as website generator tool, with the <a href="http://themes.gohugo.io/theme/material-docs/">Material Docs theme</a>. You might need to check their docs quickly.</p> -<p>Go the <code>DOCUMENTATION/_settings/content</code> and search for the markdown file you want to edit (every folder represents a section in the menu).</p> +<p>Go the <code>DOCUMENTATION/_settings/content</code> and search for the markdown file you want to edit</p> -<p>To edit the sidebar or add a new section, you need to edit this file <code>DOCUMENTATION/_settings/config.toml</code> as well.</p> +<p>Note: Every folder represents a section in the sidebar &ldquo;Menu&rdquo;. And every page and sidebar has a <code>weight</code> number to show it&rsquo;s position in the site.</p> -<p><em>The site will be autogenerated in the <code>docs/</code> folder by <a href="https://travis-ci.com/">Travis</a>.</em></p> +<p>To update the sidebar or add a new section to it, you can edit this <code>DOCUMENTATION/_settings/config.toml</code> toml file.</p> + +<blockquote> +<p>The site will be auto-generated in the <code>docs/</code> folder by <a href="https://travis-ci.org/laradock/laradock/">Travis CI</a>.</p> +</blockquote> + +<p><br></p> <h3 id="to-host-the-website-locally">To Host the website locally</h3> <ol> -<li>Install <a href="https://gohugo.io/">Hugo</a> on your machine (easy thing).</li> +<li>Install <a href="https://gohugo.io/">Hugo</a> on your machine.</li> <li>Edit the <code>DOCUMENTATION/_settings/content</code>.</li> <li>Delete the <code>/docs</code> folder from the root.</li> -<li>When you finish editing, go to <code>DOCUMENTATION/_settings/</code> and run the <code>hugo</code> command to generate the HTML docs (inside new <code>/docs</code> folder).</li> +<li>After you finish the editing, go to <code>DOCUMENTATION/_settings/</code> and run the <code>hugo</code> command to generate the HTML docs (inside a new <code>/docs</code> folder).</li> </ol> <h2 id="how-to-support-new-software-add-new-container">How to support new Software (Add new Container)</h2>