-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
📝 docs: rename installation to readme in order to be readable from Gi…
…thub repository
- Loading branch information
1 parent
6de2392
commit 9749385
Showing
1 changed file
with
60 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,60 @@ | ||
# Hugo | ||
|
||
Hugo is a static site generator written in Go, optimized for speed and designed for flexibility. | ||
|
||
## Prerequisites | ||
|
||
- [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) | ||
- [Go](https://go.dev/doc/install) | ||
- [Dart Sass](https://gohugo.io/hugo-pipes/transpile-sass-to-css/#dart-sass) | ||
|
||
## Installation | ||
|
||
Install the [Hugo](https://gohugo.io/installation/) with respect to your Operating System (OS). | ||
|
||
## Setup | ||
|
||
Follow the instruction below: | ||
|
||
1. Create a new project: | ||
|
||
```bash | ||
hugo new site hugo-blog | ||
``` | ||
|
||
2. Navigate to Hugo project root: | ||
|
||
```bash | ||
cd hugo-blog | ||
``` | ||
|
||
3. Install the `book` theme: | ||
|
||
```bash | ||
git submodule add https://github.com/alex-shpak/hugo-book themes/hugo-book | ||
``` | ||
|
||
4. Modify the configuration and add the `book` theme to `hugo.toml`: | ||
|
||
```toml | ||
baseURL = 'https://wiki.databurst.ir' | ||
languageCode = 'en-us' | ||
title = 'Databurst Data Engineering Wiki' | ||
theme = "hugo-book" | ||
``` | ||
|
||
5. [optional] Copy the sample content from existing examples: | ||
|
||
```bash | ||
cp -R themes/hugo-book/exampleSite/content.en/* ./content | ||
``` | ||
|
||
6. Start the **development** server: | ||
|
||
```bash | ||
hugo server | ||
``` | ||
|
||
## Useful Links | ||
|
||
- [Book theme documentation](https://themes.gohugo.io/themes/hugo-book/) |