Igor Laborie
6 years ago
@ -1,5 +1,4 @@ |
||||
_gen/ |
||||
test-hugo/themes/ananke/ |
||||
test-hugo/public/ |
||||
/resources/ |
||||
public/ |
||||
node_modules/ |
||||
.firebase/ |
||||
@ -1,6 +0,0 @@ |
||||
[submodule "themes/ga-hugo-theme"] |
||||
path = themes/ga-hugo-theme |
||||
url = https://github.com/giraffeacademy/ga-hugo-theme |
||||
[submodule "test-hugo/themes/ga-hugo-theme"] |
||||
path = test-hugo/themes/ga-hugo-theme |
||||
url = https://github.com/giraffeacademy/ga-hugo-theme |
||||
@ -0,0 +1,71 @@ |
||||
# Proto Site DevFest 2019 |
||||
|
||||
## Requirement |
||||
|
||||
* [Install Hugo](https://gohugo.io/getting-started/installing/) |
||||
Note: you need to install the extended version. |
||||
|
||||
* If you need to use tools, or deploy, you also need [NodeJS](https://nodejs.org/en/) and [Yarn](https://yarnpkg.com/lang/en/docs/install). |
||||
|
||||
|
||||
## Run Local site |
||||
|
||||
|
||||
Just run |
||||
|
||||
``` |
||||
hugo server -D |
||||
``` |
||||
|
||||
Notice that the `-D` flag is used to rendrer draft elements. |
||||
|
||||
More information [here](https://gohugo.io/commands/hugo_server/) |
||||
|
||||
## Build |
||||
|
||||
Just run |
||||
|
||||
``` |
||||
hugo |
||||
``` |
||||
|
||||
|
||||
More information [here](https://gohugo.io/commands/hugo/) |
||||
|
||||
## Edit data |
||||
|
||||
You can edit |
||||
|
||||
- general information about the site into the `config.toml` file. |
||||
- some data into `data/*.yml` files, like header or footer information |
||||
- some content into `content/**` files. |
||||
- some static assets like images into the `static/*` folder |
||||
|
||||
### Create a new blog entry |
||||
|
||||
You can use `hugo new blog/i-create-a-new-entry.md` command and then edit it. |
||||
Or just copy an already existing blog entry, and update the content. |
||||
|
||||
|
||||
## Tooling |
||||
|
||||
First you need to install dependencies with `yarn`. |
||||
|
||||
|
||||
### Publish |
||||
|
||||
To publish the site on firebase, just run `firebase deploy`. |
||||
Note that you need to authenticate once with `firebase login` |
||||
|
||||
|
||||
### Extract data from CFP |
||||
|
||||
TODO... |
||||
|
||||
|
||||
## TODO |
||||
|
||||
* [] i18n |
||||
* [] a11y |
||||
* [] optimizations |
||||
* [] more tooling |
||||
|
Before Width: | Height: | Size: 71 KiB After Width: | Height: | Size: 71 KiB |
|
Before Width: | Height: | Size: 97 KiB After Width: | Height: | Size: 97 KiB |
|
Before Width: | Height: | Size: 73 KiB After Width: | Height: | Size: 73 KiB |
|
Before Width: | Height: | Size: 190 KiB After Width: | Height: | Size: 190 KiB |
|
Before Width: | Height: | Size: 70 KiB After Width: | Height: | Size: 70 KiB |
|
Before Width: | Height: | Size: 23 KiB After Width: | Height: | Size: 23 KiB |
|
Before Width: | Height: | Size: 4.3 KiB After Width: | Height: | Size: 4.3 KiB |
|
Before Width: | Height: | Size: 156 KiB After Width: | Height: | Size: 156 KiB |
|
Before Width: | Height: | Size: 64 KiB After Width: | Height: | Size: 64 KiB |