Data

Tools

Indexes

Applications

Experiments

Open Source Science

https://github.com/cessda/cessda.documentation.theme

CESSDA theme for just-the-docs

https://github.com/cessda/cessda.documentation.theme

Science Score: 13.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ○
    .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (10.7%) to scientific vocabulary
Last synced: 10 months ago · JSON representation

Repository

CESSDA theme for just-the-docs

Basic Info
  • Host: GitHub
  • Owner: cessda
  • License: mit
  • Language: SCSS
  • Default Branch: master
  • Homepage:
  • Size: 2.23 MB
Statistics
  • Stars: 0
  • Watchers: 2
  • Forks: 0
  • Open Issues: 2
  • Releases: 1
Created over 3 years ago · Last pushed almost 2 years ago
Metadata Files
Readme Changelog License

README.md

jekyll-cessda-docs

CESSDA theme for just-the-docs. These are the source files for building the gem.

Building and pushing

  1. set up git and RubyGems user. Instructions here: https://jekyllrb.com/docs/themes/#publishing-your-theme
  2. Update the file jekyll-cessda-docs.gemspec with the new version number, for example: spec.version = "0.1.4"

  3. Build the gem:

    sh gem build jekyll-cessda-docs.gemspec

  4. Push to Rubygems.org:

    sh gem push jekyll-cessda-docs-*.gem

Installing

Add this line to your Jekyll site's Gemfile:

ruby gem "jekyll-cessda-docs"

And add this line to your Jekyll site's _config.yml:

yaml theme: jekyll-cessda-docs

And then execute:

sh bundle

Or install it yourself as:

sh gem install jekyll-cessda-docs

See the CESSDA documentation for more details.

Development

To set up your environment to develop this theme, run bundle install.

Your theme is setup just like a normal Jekyll site! To test your theme, run bundle exec jekyll serve and open your browser at http://localhost:4000. This starts a Jekyll server using your theme. Add pages, documents, data, etc. like normal to test your theme's contents. As you make modifications to your theme and to your content, your site will regenerate and you should see the changes in the browser after a refresh, just like normal.

When your theme is released, only the files in _layouts, _includes, _sass and assets tracked with Git will be bundled. To add a custom directory to your theme-gem, please edit the regexp in jekyll-cessda-docs.gemspec accordingly.

License

The theme is available as open source under the terms of the MIT License.

GitHub Events

Total
  • Create event: 1
  • Release event: 1
  • Issues event: 2
  • Delete event: 1
  • Issue comment event: 1
  • Pull request review event: 1
  • Pull request event: 2
Last Year
  • Create event: 1
  • Release event: 1
  • Issues event: 2
  • Delete event: 1
  • Issue comment event: 1
  • Pull request review event: 1
  • Pull request event: 2