6 |
7 |
8 | 
9 |
10 | This is a [starter template](https://vsoch.github.com/docsy-jekyll/) for a Docsy jekyll theme, based
11 | on the Beautiful [Docsy](https://github.com/google/docsy) that renders with Hugo. This version is intended for
12 | native deployment on GitHub pages. The original [Apache License](https://github.com/vsoch/docsy-jekyll/blob/master/LICENSE) is included.
13 |
14 | ## Changes
15 |
16 | The site is intended for purely documentation, so while the front page banner
17 | is useful for business or similar, this author (@vsoch) preferred to have
18 | the main site page go directly to the Documentation view. Posts
19 | are still provided via a feed.
20 |
21 | ## Usage
22 |
23 | ### 1. Get the code
24 |
25 | You can clone the repository right to where you want to host the docs:
26 |
27 | ```bash
28 | git clone https://github.com/vsoch/docsy-jekyll.git docs
29 | cd docs
30 | ```
31 |
32 | ### 2. Customize
33 |
34 | To edit configuration values, customize the [_config.yml](https://github.com/vsoch/docsy-jekyll/blob/master/_config.yml).
35 | To add pages, write them into the [pages](https://github.com/vsoch/docsy-jekyll/blob/master/pages) folder.
36 | You define urls based on the `permalink` attribute in your pages,
37 | and then add them to the navigation by adding to the content of [_data/toc.myl](https://github.com/vsoch/docsy-jekyll/blob/master/_data/toc.yml).
38 | The top navigation is controlled by [_data/navigation.yml](https://github.com/vsoch/docsy-jekyll/blob/master/_data/navigation.yml)
39 |
40 | ### 3. Options
41 |
42 | Most of the configuration values in the [_config.yml](https://github.com/vsoch/docsy-jekyll/blob/master/_config.yml) are self explanatory,
43 | and for more details, see the [getting started page](https://vsoch.github.io/docsy-jekyll/docs/getting-started)
44 | rendered on the site.
45 |
46 | ### 4. Serve
47 |
48 | Depending on how you installed jekyll:
49 |
50 | ```bash
51 | jekyll serve
52 | # or
53 | bundle exec jekyll serve
54 | ```
55 |
--------------------------------------------------------------------------------
/docs/Rakefile:
--------------------------------------------------------------------------------
1 | require 'html-proofer'
2 |
3 | # See here for ideas: https://github.com/keegoid/keegoid.github.io/blob/master/Rakefile
4 | def build_site
5 | sh "bundle exec jekyll build"
6 | end
7 |
8 | def doctor_site
9 | sh 'bundle exec jekyll doctor'
10 | end
11 |
12 | def html_proofer
13 | options = {
14 | :url_ignore => [/localhost/],
15 | :empty_alt_ignore => true,
16 | :allow_hash_href => true, # don't break on
17 | :assume_extension => false, # (true) for extensionless paths
18 | :http_status_ignore => [
19 | 999, # LinkedIn throttling errors
20 | 403, # Google scholar errors thrown from Travis (links here will be public anyway)
21 | ],
22 | :typhoeus => {
23 | :connecttimeout => 20,
24 | :timeout => 60,
25 | # avoid strange SSL errors: https://github.com/gjtorikian/html-proofer/issues/376
26 | :ssl_verifypeer => false,
27 | :ssl_verifyhost => 0
28 | }
29 | }
30 | HTMLProofer.check_directory("./_site", options).run
31 | end
32 |
33 | task :test do
34 | build_site
35 | doctor_site
36 | html_proofer
37 | end
38 |
39 | task :test_local do
40 | # Already built so don't build again
41 | doctor_site
42 | html_proofer
43 | end
44 |
45 | task :default => :test
46 |
--------------------------------------------------------------------------------
/docs/VERSION:
--------------------------------------------------------------------------------
1 | 0.0.1
2 |
--------------------------------------------------------------------------------
/docs/_config.yml:
--------------------------------------------------------------------------------
1 | # Welcome to Jekyll!
2 | #
3 | # This config file is meant for settings that affect your whole blog, values
4 | # which you are expected to set up once and rarely edit after that. If you find
5 | # yourself editing these this file very often, consider using Jekyll's data files
6 | # feature for the data you need to update frequently.
7 | #
8 | # For technical reasons, this file is *NOT* reloaded automatically when you use
9 | # 'jekyll serve'. If you change this file, please restart the server process.
10 |
11 | # Site settings
12 | # These are used to personalize your new site. If you look in the HTML files,
13 | # you will see them accessed via {{ site.title }}, {{ site.email }}, and so on.
14 | # You can create any custom variable you would like, and they will be accessible
15 | # in the templates via {{ site.myvariable }}.
16 |
17 | title: OpenContainers Python
18 | email: vsochat@stnaford.edu
19 | author: "@vsoch"
20 | description: > # this means to ignore newlines until "baseurl:"
21 | A simple Python implementation of Open Containers specifications. The code
22 | is intentionally structured to mirror the go implementations for usability.
23 |
24 | # DO NOT CHANGE THE LINE OF THIS FILE without editing .circleci/circle_urls.sh
25 | baseurl: "/oci-python" # the subpath of your site, e.g. /blog
26 |
27 | # This is mostly for testing
28 | url: "https://vsoch.github.io" # the base hostname & protocol for your site
29 |
30 | # Social (First three Required)
31 | repo: "https://github.com/vsoch/oci-python"
32 | github_user: "vsoch"
33 | github_repo: "oci-python"
34 |
35 | # Optional
36 | twitter: vsoch
37 | linkedin: vsochat
38 | dockerhub: vanessa
39 |
40 | # Should there be feedback buttons at the bottom of pages?
41 | feedback: true
42 |
43 | # Link to a privacy policy in footer, uncomment and define if wanted
44 | # privacy: https://domain.com/privacy
45 |
46 | # google-analytics: UA-XXXXXXXXXX
47 | # Image and (square) dimension for logo (don't start with /)
48 | # If commented, will use material hat theme
49 | # logo: "assets/img/logo/SRCC-square-red.png"
50 | logo_pixels: 34
51 | color: "#30638e"
52 | # color: "#8c1515" # primary color for header, buttons
53 |
54 | # Build settings
55 | markdown: kramdown
56 |
57 | # If you add tags to pages, you can link them to some external search
58 | # If you want to disable this, comment the URL.
59 | tag_search_endpoint: https://ask.cyberinfrastructure.org/search?q=
60 | tag_color: danger # danger, success, warning, primary, info, secondary
61 |
62 | accentColor: red # purple, green, etc.
63 | themeColor: red # purple, green, blue, orange, purple, grey
64 | fixedNav: 'true' # true or false
65 |
66 | permalink: /:year/:title/
67 | markdown: kramdown
68 | exclude: [_site, CHANGELOG.md, LICENSE, README.md, vendor]
69 |
70 | # Collections
71 | collections:
72 | docs:
73 | output: true
74 | permalink: /:collection/:path
75 |
76 | # Defaults
77 | defaults:
78 | - scope:
79 | path: "_docs"
80 | type: "docs"
81 | values:
82 | layout: page
83 | -
84 | scope:
85 | path: ""
86 | type: "pages"
87 | values:
88 | layout: "page"
89 | -
90 | scope:
91 | path: "posts"
92 | type: "posts"
93 | values:
94 | layout: "post"
95 |
--------------------------------------------------------------------------------
/docs/_data/navigation.yml:
--------------------------------------------------------------------------------
1 | - title: About
2 | url: about
3 | - title: Documentation
4 | url: docs
5 |
--------------------------------------------------------------------------------
/docs/_data/quizzes/example-quiz.yml:
--------------------------------------------------------------------------------
1 | title: This is the Quiz Title
2 | randomized: false
3 | questions:
4 |
5 | - type: "multiple-choice"
6 | question: "What is your favorite color?"
7 | items:
8 | - choice: Red
9 | correct: null
10 | - choice: Blue
11 | correct: null
12 | - choice: Green
13 | correct: null
14 | followup: There is no correct answer to asking your favorite color! All choices would be good.
15 |
16 | - type: "multiple-choice"
17 | question: "True or False, Pittsburgh is West of Philadelphia"
18 | items:
19 | - choice: True
20 | correct: true
21 | - choice: False
22 | correct: false
23 | followup: |
24 | The answer is True! Pittsburgh is 304.9 miles West of Philadelphia, or approximately
25 | a car ride of 4 hours and 52 minutes. Buckle up!
26 |
--------------------------------------------------------------------------------
/docs/_data/toc.yml:
--------------------------------------------------------------------------------
1 | - title: Documentation
2 | url: docs
3 | links:
4 | - title: "Getting Started"
5 | url: "docs/getting-started"
6 | children:
7 | - title: Install
8 | url: "docs/getting-started#getting-started"
9 | - title: "Distribution Specification"
10 | url: "docs/getting-started#distribution-specification"
11 | children:
12 | - title: Reggie Client
13 | url: "docs/getting-started#reggie"
14 | - title: "Image Specification"
15 | url: "docs/getting-started#image-specification"
16 | children:
17 | - title: Manifests
18 | url: "docs/getting-started#image-manifest"
19 | - title: Descriptor
20 | url: "docs/getting-started#descriptor"
21 | - title: Digests
22 | url: "docs/getting-started#digest"
23 | - title: Algorithms
24 | url: "docs/getting-started#algorithms"
25 | - title: "About"
26 | url: "about"
27 | - title: "News"
28 | url: "news"
29 |
--------------------------------------------------------------------------------
/docs/_includes/alert.html:
--------------------------------------------------------------------------------
1 | Was this page helpful?
18 | 19 | 20 |21 | Glad to hear it! Please tell us how we can improve. 22 |
23 |24 | Sorry to hear that. Please tell us how we can improve. 25 |
26 | {% endif %}{% if include.item.question %}{{ include.item.question }}{% else %}Question {{ include.count }}{% endif %}
3 |{% for choice in include.item.items %}{% if choice.correct == true %}{% endif %}{{ forloop.index }}. {{ choice.choice }}{% if choice.correct == true %}{% endif %}
{% endfor %}
{{ child.description }}
40 |" + contentPreview + "
{{ post.description }}
18 |Subscribe with RSS to keep up with the latest news. 9 | For site changes, see the changelog kept with the code base.
10 | 11 |Loading results
13 | 14 |