Skip to content

Commit

Permalink
Fix documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
francescobianco committed Feb 29, 2024
1 parent b7127c3 commit 2237be9
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 31 deletions.
15 changes: 5 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,22 +22,17 @@ Find more projects, themes and step-by-step tutorials at [Javanile Package Store
## Setup

1. Setup fresh new GitHub repository
2. Add `_config.yml` as the follow <>.
2. Add `_config.yml` as the follow <https://github.com/javanile/package-manager/blob/main/_config.example.yml>.
3. Enable GitHub Pages in the repository settings

## Develop

Base was built with [Jekyll](http://jekyllrb.com/) version 3.4.3, but should support newer versions as well.
Package Manager was built with [Jekyll](http://jekyllrb.com/) version 3.4.3, but should support newer versions as well.

Install the dependencies with [Bundler](http://bundler.io/):
Install the dependencies and run it with Makefile based on [Docker](http://docker.com/):

~~~bash
$ bundle install
~~~

Run `jekyll` commands through Bundler to ensure you're using the right versions:

~~~bash
$ bundle exec jekyll serve
$ make serve
~~~

## Editing
Expand Down
25 changes: 4 additions & 21 deletions _config.example.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@

title: Package Manager
remote_theme: javanile/package-manager@main

logo: https://raw.githubusercontent.com/javanile/package-manager/main/assets/images/logo.png
primary_color: "#000"
secondary_color: "#EEE"

alert:
type: info
Expand All @@ -11,23 +15,6 @@ disqus_shortname:
google_analytics_key:
newsletter_action:

# Values for the jekyll-seo-tag gem (https://github.com/jekyll/jekyll-seo-tag)
description: Knowledge base template for Jekyll.
author:
name:
email:
twitter: # twitter username without the @ symbol
social:
name: Base Template
links:
- https://github.com/CloudCannon/base-jekyll-template

#primary_color: "#000"
#secondary_color: "#EEE"

# -----
# Build

timezone: Etc/UTC

permalink: /:categories/:title/
Expand All @@ -46,7 +33,6 @@ exclude:
- vendor/*
- packages/*


defaults:
-
scope:
Expand All @@ -70,9 +56,6 @@ defaults:
values:
body_class: "show_hero_search"

# -----------
# CloudCannon

social_icons:
- Facebook
- Google Plus
Expand Down

0 comments on commit 2237be9

Please sign in to comment.