Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
Signed-off-by: Navid Yaghoobi <[email protected]>
  • Loading branch information
navidys committed Nov 6, 2023
1 parent 81478fc commit 22a357d
Show file tree
Hide file tree
Showing 5 changed files with 19 additions and 9 deletions.
7 changes: 3 additions & 4 deletions .github/workflows/jekyll-gh-pages.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,9 @@ jobs:
- name: Setup Pages
uses: actions/configure-pages@v3
- name: Build with Jekyll
uses: actions/jekyll-build-pages@v1
with:
source: ./docs/
destination: ./_site
run: |
make docs
- name: Upload artifact
uses: actions/upload-pages-artifact@v2

Expand Down
8 changes: 4 additions & 4 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ docs/github.io/_site
docs/github.io/.sass-cache
docs/github.io/.jekyll-cache
docs/github.io/.jekyll-metadata
vendor/bundle/
vendor/cache/
vendor/gems/
vendor/ruby/
docs/github.io/vendor/bundle/
docs/github.io/vendor/cache/
docs/github.io/vendor/gems/
docs/github.io/vendor/ruby/
4 changes: 4 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,10 @@ $(TARGET): $(SRC)
@mkdir -p $(BIN)
$(GO) build $(BUILDFLAGS) -o $(BIN)/$(TARGET) ./cmd/$(TARGET)/

.PHONY: docs
docs: ## Generates html documents
@sh hack/build_docs.sh

#=================================================
# Required tools installation tartgets
#=================================================
Expand Down
1 change: 0 additions & 1 deletion _config.yml → docs/_config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ domain: gopensky
logo: "/assets/images/radar.png"
author: Navid Yaghoobi
repo_url: 'https://github.com/navidys/gopensky'
source: docs/

# Build settings
theme: just-the-docs
Expand Down
8 changes: 8 additions & 0 deletions hack/build_docs.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
#!/usr/bin/env bash
set -e

current_dir=$(pwd)
cd docs/
bundle install
bundle exec jekyll build
cd $current_dir

0 comments on commit 22a357d

Please sign in to comment.