Coder Social home page Coder Social logo

jekyll-rtd-theme

CI jsDelivr

Just another documentation theme compatible with GitHub Pages

What it does?

This theme is inspired by sphinx-rtd-theme and refactored with:

Quick start

remote_theme: rundocs/jekyll-rtd-theme

You can generate with the same files and folders from rundocs/starter-slim

Usage

Documentation that can guide how to create with Github pages, please refer to rundocs.io for details

Features

  • Shortcodes (Toasts card, mermaid)
  • Pages Plugins (emoji, gist, avatar, mentions)
  • Auto generate sidebar
  • Attribute List Definitions (Primer/css utilities, Font Awesome 4)
  • Service worker (caches)
  • SEO (404, robots.txt, sitemap.xml)
  • Canonical Link (Open Graph, Twitter Card, Schema data)

Options

name default value description
title repo name
description repo description
url user domain or cname
baseurl repo name
lang en
direction auto ltr or rtl
highlighter rouge Cannot be changed
# folders sort
readme_index:
  with_frontmatter: true

meta:
  key1: value1
  key2: value2
  .
  .
  .

google:
  gtag:
  adsense:

mathjax: # this will prased to json, default: {}

mermaid:
  custom:     # mermaid link
  initialize: # this will prased to json, default: {}

scss:   # also _includes/extra/styles.scss
script: # also _includes/extra/script.js

translate:
  # shortcodes
  danger:
  note:
  tip:
  warning:
  # 404
  not_found:
  # copyright
  revision:
  # search
  searching:
  search:
  search_docs:
  search_results:
  search_results_found: # the "#" in this translate will replaced with results size!
  search_results_not_found:

plugins:
  - jemoji
  - jekyll-avatar
  - jekyll-mentions

The license

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

TeamM_LEE's Projects

awesome-lidar icon awesome-lidar

😎 Awesome LIDAR list. The list includes LIDAR manufacturers, datasets, point cloud-processing algorithms, point cloud frameworks and simulators.

cloudpointconverter icon cloudpointconverter

This is simple util for converting files received from lidar at iPhone into formats supported by ReCap Pro.

clustering-example icon clustering-example

This app is clustering example. It has k-Means algorithm, DBSCAN algorithm, Agglomerative algorithm.

darknet icon darknet

YOLOv4 / Scaled-YOLOv4 / YOLO - Neural Networks for Object Detection (Windows and Linux version of Darknet )

dbscan icon dbscan

Implementation of DBSCAN Algorithm in Python.

dbscan-1 icon dbscan-1

python implementation of dbscan from scratch

dbscan-2 icon dbscan-2

original python implementation, no scikit-learn involved

dbscan-python icon dbscan-python

Python implementation of 'DBSCAN' Algorithm Using only Numpy and Matplotlib

dearpygui icon dearpygui

Dear PyGui: A fast and powerful Graphical User Interface Toolkit for Python with minimal dependencies

faster-lio icon faster-lio

Faster-LIO: Lightweight Tightly Coupled Lidar-inertial Odometry using Parallel Sparse Incremental Voxels

gopro-telemetry icon gopro-telemetry

Reads telemetry from the GPMF track in GoPro cameras (Hero5 and later) and converts it to multiple formats

lcd icon lcd

This repository contains all of the code for interfacing with a 16x2 Character I2C LCD Display. This accompanies my YouTube tutorial here:

mlalgorithms icon mlalgorithms

Python implementations of conventional Machine Learning Algorithms.

py-st-dbscan icon py-st-dbscan

An implementation of ST-DBScan algorithm using Python language

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.