Giter Club home page Giter Club logo

Edition

Product documentation template for Jekyll. Browse through a live demo. Start documenting your product, application, service or website with this configurable theme.

Edition template screenshot

Edition was made by CloudCannon, the Cloud CMS for Jekyll.

Find more templates, themes and step-by-step Jekyll tutorials at CloudCannon Academy.

Features

  • Two column layout
  • Full text search
  • Pre-styled components
  • Auto-generated navigation based on category
  • Optimised for editing in CloudCannon
  • Change log
  • RSS/Atom feed
  • SEO tags
  • Google Analytics

Setup

  1. Add your site and author details in _config.yml.
  2. Get a workflow going to see your site's output (with CloudCannon or Jekyll locally).

Develop

Edition was built with Jekyll version 3.3.1, but should support newer versions as well.

Install the dependencies with Bundler:

$ bundle install

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

$ bundle exec jekyll serve

Editing

Edition is already optimised for adding, updating and removing documentation pages in CloudCannon.

Documentation pages

  • Add, update or remove a documentation page in the Documentation collection.
  • Change the category of a documentation page to move it to another section in the navigation.
  • Documentation pages are organised in the navigation by category, with URLs based on the path inside the _docs folder.

Change log

  • Add, update or remove change log entries from your posts.
  • Tag entries as minor or major in the front matter.

Search

  • Add excluded_in_search: true to any documentation page's front matter to exclude that page in the search results.

Navigation

  • Change site.show_full_navigation to control all or only the current navigation group being open.

DynamicDeepSKY's Projects

esp32-cam_motion icon esp32-cam_motion

ESP32 Camera extension to allow the camera to detect movement using image centre of mass shift

fbtft icon fbtft

Linux Framebuffer drivers for small TFT LCD display modules

linux icon linux

Kernel source tree for Raspberry Pi Foundation-provided kernel builds. Issues unrelated to the linux kernel should be posted on the community forum at https://www.raspberrypi.org/forum

luma.oled icon luma.oled

Python module to drive a SSD1306 / SSD1309 / SSD1322 / SSD1325 / SSD1327 / SSD1331 / SSD1351 / SH1106 OLED

motion-ai icon motion-ai

AI assisted motion detection for Home Assistant

page icon page

:books: Product documentation template for Jekyll

picamera icon picamera

A pure Python interface to the Raspberry Pi camera module

video_stream_opencv icon video_stream_opencv

A package to open video streams and publish them in ROS using the opencv videocapture mechanism

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.