Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

opengitdocs

Package Overview
Dependencies
Maintainers
1
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

opengitdocs

  • 0.1.0
  • Rubygems
  • Socket score

Version published
Maintainers
1
Created
Source

OpenGitDocs for Jekyll 🧪

A straightforward documentation site theme for static sites built with Jekyll.

To preview the theme and read the docs, see the site that this repository builds at opengitdocs.com/jekyll.

Features

  • A smart, automatically generated sidebar menu
    • Content ordered by your sections, with nested pages
    • A config option to hide nested pages and show only top level pages
  • Built-in light and dark themes you can switch with a config option
  • Your choice of custom sidebar color and syntax highlighting theme

Theme screenshot

Installation

This theme can be installed as a Gemfile, as a remote theme using GitHub Pages, or by manually copying the theme files. See full instructions here.

Usage

Layouts include:

  • An index, or home page.
  • page to show a list of available documents: see example.
  • post to show a single document: see example.

Configuration

See a sample configuration file and instructions here. OpenGitDocs sets reasonable defaults for missing non-required parameters. Any parameters you set in your site's configuration will override the theme defaults.

FAQs

Package last updated on 04 Mar 2020

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc