https://github.com/naskio/jekyll-folder-example

Jekyll example where we use a folder `Docs/` for hosting the website.
https://github.com/naskio/jekyll-folder-example

jekyll jekyll-example

Last synced: 1 day ago
JSON representation

Jekyll example where we use a folder `Docs/` for hosting the website.

• Host: GitHub
• URL: https://github.com/naskio/jekyll-folder-example
• Owner: naskio
• License: mit
• Created: 2022-07-10T20:18:23.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-11-28T14:35:49.000Z (about 2 years ago)
• Last Synced: 2024-11-10T14:44:51.850Z (about 2 months ago)
• Topics: jekyll, jekyll-example
• Language: JavaScript
• Homepage: https://naskio.github.io/jekyll-folder-example/
• Size: 1.65 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# jekyll-folder-example

Jekyll example where we use a folder `docs/` for hosting the website.

# Steps

1. refactoring

    - add `assets/` folder into `docs/`

    - Put all markdown files in `docs/_docs/`

2. Generate Jekyll site

   ```shell

   cd docs/

   jekyll new --skip-bundle .

   ```

3. Add dependencies to Gemfile

4. Install dependencies

   ```shell

   bundle install

   ```

5. Config Jekyll site `_config.yml` and `_config.development.yml`

6. Run

   ```shell

   jekyll serve --config _config.yml,_config.development.yml

   ```

7. Use Collections

> Folder should be named `docs` all lowercase.

## Data Generation

```shell

brew install yq

curl https://api.github.com/repos/m4rs-mt/ILGPU/releases | yq -P > Desktop/jekyll-folder-example/docs/_data/releases.yml

curl https://api.github.com/repos/m4rs-mt/ILGPU/milestones | yq -P > Desktop/jekyll-folder-example/docs/_data/milestones.yml

```