msfjarvis/msfjarvis.dev
1
0
Fork 0
mirror of https://github.com/msfjarvis/msfjarvis.dev.git synced 2024-06-03 04:18:56 +05:30
Code Issues Packages Projects Releases Wiki Activity

docs: update README

Browse Source
This commit is contained in:
Jake Wiesler 2020-06-17 11:28:10 -04:00
parent ec0f3ff3bd
commit 9c256507a2
1 changed files with 6 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
README.md
View File

@ -5,39 +5,20 @@ A minimal blog theme built for [Hugo](https://gohugo.io/) 🍜
- An about page 👋🏻 and a blog 📝 - An about page 👋🏻 and a blog 📝
- Blog posts can be tagged 🏷 - Blog posts can be tagged 🏷
### Getting Started ### Getting started
**1. Start a new `hugo` site** At the root of your Hugo project, run:
``` ```bash
hugo new site my-new-site
cd my-new-site
```
**2. Initialize project with `git`**
```
git init
```
**3. Add `hugo-theme-codex` as a submodule**
```
git submodule add https://github.com/jakewies/hugo-theme-codex.git themes/codex git submodule add https://github.com/jakewies/hugo-theme-codex.git themes/codex
``` ```
**4. List `"codex"` as the name of your theme in `config.toml`** Next, copy the contents of the [default `config.toml`](https://github.com/jakewies/hugo-theme-codex/blob/master/exampleSite/config.toml) to your site's `config.toml`. Make sure to read all the comments, as there a few nuances with Hugo themes that require some changes to that file.
```toml Finally, run:
# config.toml
theme = "codex"
```
**5. Start the server**
``` ```
hugo server -D hugo server -D
``` ```
**Note: If you are seeing a blank page it is probably because you have nothing in your `content/` directory. Read on to fix that.** **Note: If you are seeing a blank page it is probably because you have nothing in your `content/` directory. Read on to fix that.**