https://github.com/frc2052/prdocs.github.io

Wiki for PR
https://github.com/frc2052/prdocs.github.io

Last synced: about 2 months ago
JSON representation

Wiki for PR

• Host: GitHub
• URL: https://github.com/frc2052/prdocs.github.io
• Owner: frc2052
• License: mit
• Created: 2019-06-10T23:25:10.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2022-10-06T05:42:01.000Z (about 2 years ago)
• Last Synced: 2024-03-26T05:04:06.747Z (10 months ago)
• Language: CSS
• Size: 1.41 MB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Jekyll Doc Theme

Go to [the website](https://aksakalli.github.io/jekyll-doc-theme/) for detailed information and demo.

## Running locally

You need Ruby and gem before starting, then:

```bash

# install bundler

gem install bundler

# clone the project

git clone https://github.com/aksakalli/jekyll-doc-theme.git

cd jekyll-doc-theme

# run jekyll with dependencies

bundle exec jekyll serve

```

## Docker

Alternatively, you can deploy it using the multi-stage [Dockerfile](Dockerfile)

that serves files from Nginx for better performance in production.

Build the image for your site's `JEKYLL_BASEURL`:

```

docker build --build-arg JEKYLL_BASEURL="/your-base/url" -t jekyll-doc-theme .

```

(or leave it empty for root: `JEKYLL_BASEURL=""`) and serve it:

```

docker run -p 8080:80 jekyll-doc-theme

```

## License

Released under [the MIT license](LICENSE).