diff options
Diffstat (limited to 'exampleSite/content/getting-start/installation/_index.md')
| -rw-r--r-- | exampleSite/content/getting-start/installation/_index.md | 52 |
1 files changed, 12 insertions, 40 deletions
diff --git a/exampleSite/content/getting-start/installation/_index.md b/exampleSite/content/getting-start/installation/_index.md index b3b1212..33cc35b 100644 --- a/exampleSite/content/getting-start/installation/_index.md +++ b/exampleSite/content/getting-start/installation/_index.md @@ -2,6 +2,7 @@ title = "Installation" description = "" weight = 1 + +++ {{% alert theme="warning" %}}HUGO **v0.50** minimum required to use this theme (prefer extended version if you want to modify this theme source{{%/alert%}} @@ -11,17 +12,11 @@ weight = 1 The following steps are here to help you initialize your new website. If you don’t know Hugo at all, we strongly suggest you to train by following this [great documentation for beginners](https://gohugo.io/overview/quickstart/). <!--more--> -## Installation - -We assume that all changes to Hugo content and customizations are going to be tracked by git (GitHub, Bitbucket etc.). Develop locally, build on remote system. -Before start real work: -1. Initialize Hugo -2. Install DocPort theme -3. Configure DocPort and Hugo +We assume that all changes to Hugo content and customizations are going to be tracked by git (GitHub, Bitbucket etc.). Develop locally, build on remote system. -### Prepare empty Hugo site +## Prepare empty Hugo site Create empty directory, which will be root of your Hugo project. Navigate there and let Hugo to create minimal required directory structure: ``` @@ -32,21 +27,17 @@ After that, initialize this as git directory where to track further changes $ git init ``` -### Install DocPort - -Next, there are at least three ways to install DocPort (first recommended): +## Install DocPort as git submodule -1. **As git submodule** -2. As git clone -3. As direct copy (from ZIP) - -Navigate to your themes folder in your Hugo site and use perform one of following scenarios. - -#### 1. Install DocPort as git submodule +{{%alert%}} +**Alernatives to submodules** +\ +There are other ways to install DocPort. If submodule is no-go, use [install as git clone]({{%ref "as-git-clone/_index.md"%}}) or [install from a zip archive]({{%ref "direct copy/_index.md"%}}) +{{%/alert%}} DocPort will be added like a dependency repo to original project. When using CI tools like Netlify, Jenkins etc., submodule method is required, or you will get `theme not found` issues. Same applies when building site on remote server trough SSH. -If submodule is no-go, use 3rd option. + On your root of Hugo execute: @@ -60,27 +51,8 @@ $ git submodule init $ git submodule update ``` -Now you are ready to add content and customize looks. Do not change any file inside themes directory. - -If you want to freeze changes to DocPort theme itself and use still submodules, fork private copy of DocPort and use that as submodule. When you are ready to update theme, just pull changes from origin to your private fork. - -#### 2. Install DocPort simply as git clone - -This method results that files are checked out locally, but won't be visible from parent git repo. Probably you will build site locally with `hugo` command and use result from `public/` on your own. - -``` -$ git clone https://github.com/vjeantet/hugo-theme-docport.git themes/docport -``` - - -#### 3. Install DocPort from ZIP - -All files from theme will be tracked inside parent repo, to update it, have to override files in theme. [{{%icon cloud_download%}} download zip](https://github.com/vjeantet/hugo-theme-docport/archive/master.zip) and extract inside `themes/`. - -``` -https://github.com/vjeantet/hugo-theme-docport/archive/master.zip -``` -Name of theme in next step will be `hugo-theme-docport-master`, can rename as you wish. +Now you are ready to add content and build your documentatyion. +{{%notice warning%}}Do not change any file inside themes directory.{{%/notice%}} ## Configuration |