Skip to content

Commit 3b6bf18

Browse files
committed
Add new Hugo Docsy based approach
1 parent 5df5b84 commit 3b6bf18

File tree

1,111 files changed

+43494
-15715
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,111 files changed

+43494
-15715
lines changed

.cspell.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# cSpell:ignore textlintrc
2+
# For settings, see
3+
# https://www.streetsidesoftware.com/vscode-spell-checker/docs/configuration/
4+
version: '0.2'
5+
caseSensitive: true
6+
words:
7+
- Docsy
8+
- Goldydocs

.github/workflows/hugo-gh.yaml

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
# Sample workflow for building and deploying a Hugo site to GitHub Pages
2+
name: Deploy Hugo site to Pages
3+
4+
on:
5+
# Runs on pushes targeting the default branch
6+
push:
7+
branches:
8+
- main
9+
10+
# Allows you to run this workflow manually from the Actions tab
11+
workflow_dispatch:
12+
13+
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
14+
permissions:
15+
contents: read
16+
pages: write
17+
id-token: write
18+
19+
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
20+
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
21+
concurrency:
22+
group: "pages"
23+
cancel-in-progress: false
24+
25+
# Default to bash
26+
defaults:
27+
run:
28+
shell: bash
29+
30+
jobs:
31+
# Build job
32+
build:
33+
runs-on: ubuntu-latest
34+
env:
35+
HUGO_VERSION: 0.137.1
36+
steps:
37+
- name: Install Hugo CLI
38+
run: |
39+
wget -O ${{ runner.temp }}/hugo.deb https://github.com/gohugoio/hugo/releases/download/v${HUGO_VERSION}/hugo_extended_${HUGO_VERSION}_linux-amd64.deb \
40+
&& sudo dpkg -i ${{ runner.temp }}/hugo.deb
41+
- name: Install Dart Sass
42+
run: sudo snap install dart-sass
43+
- name: Checkout
44+
uses: actions/checkout@v4
45+
with:
46+
submodules: recursive
47+
fetch-depth: 0
48+
- name: Setup Pages
49+
id: pages
50+
uses: actions/configure-pages@v5
51+
- name: Install Node.js dependencies
52+
run: "[[ -f package-lock.json || -f npm-shrinkwrap.json ]] && npm ci || true"
53+
- name: Install postCSS
54+
run: npm install --save-dev autoprefixer postcss-cli
55+
- name: Build with Hugo
56+
env:
57+
HUGO_CACHEDIR: ${{ runner.temp }}/hugo_cache
58+
HUGO_ENVIRONMENT: production
59+
TZ: America/Los_Angeles
60+
run: |
61+
hugo \
62+
--gc \
63+
--minify \
64+
--baseURL "${{ steps.pages.outputs.base_url }}/"
65+
- name: Upload artifact
66+
uses: actions/upload-pages-artifact@v3
67+
with:
68+
path: ./public
69+
70+
# Deployment job
71+
deploy:
72+
environment:
73+
name: github-pages
74+
url: ${{ steps.deployment.outputs.page_url }}
75+
runs-on: ubuntu-latest
76+
needs: build
77+
steps:
78+
- name: Deploy to GitHub Pages
79+
id: deployment
80+
uses: actions/deploy-pages@v4

.gitignore

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
/public
2+
resources/
3+
node_modules/
4+
package-lock.json
5+
.hugo_build.lock
6+
*.sum
7+
*.work

README.md

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,21 @@
1-
## Mars Simulation Project (mars-sim)
1+
# MarsSim Example
22

3-
### Project Website's Repo :
4-
https://github.com/mars-sim/mars-sim.github.io
3+
This is a PoC of an web site for the MarsSim project based on Docsy.
54

6-
### Project Website :
7-
https://mars-sim.github.io
85

9-
### Issue Tracker :
10-
https://github.com/mars-sim/mars-sim/issues
6+
## Running the website locally
117

12-
### Wikis :
13-
https://github.com/mars-sim/mars-sim/wiki
8+
Building and running the site locally requires a recent `extended` version of [Hugo](https://gohugo.io).
9+
You can find out more about how to install Hugo for your environment in our
10+
[Getting started](https://www.docsy.dev/docs/getting-started/#prerequisites-and-installation) guide.
1411

15-
### Codebase :
16-
https://github.com/mars-sim/mars-sim-git
12+
Once you've made your working copy of the site repo, from the repo root folder, run:
1713

14+
```bash
15+
hugo server
16+
```
1817

1918

19+
[Docsy user guide]: https://docsy.dev/docs
20+
[Docsy]: https://github.com/google/docsy
21+
[example.docsy.dev]: https://example.docsy.dev

assets/css/fontawesome-all.min.css

Lines changed: 0 additions & 101 deletions
This file was deleted.

assets/css/images/ie/grad0-15.svg

Lines changed: 0 additions & 9 deletions
This file was deleted.

assets/css/images/overlay.png

-54 KB
Binary file not shown.

0 commit comments

Comments
 (0)