Skip to content

Commit

Permalink
removed old test folder and basic doc added
Browse files Browse the repository at this point in the history
  • Loading branch information
ombhilare999 committed Sep 8, 2021
1 parent 5590dc2 commit 529d883
Show file tree
Hide file tree
Showing 36 changed files with 13 additions and 653 deletions.
103 changes: 11 additions & 92 deletions README.md
@@ -1,100 +1,19 @@
# jekyll-rtd-theme
# PyFive

![CI](https://github.com/rundocs/jekyll-rtd-theme/workflows/CI/badge.svg?branch=develop)
![jsDelivr](https://data.jsdelivr.com/v1/package/gh/rundocs/jekyll-rtd-theme/badge)
- The original goal of the PyFive project is to create a RISC-V based microcontroller with the ability to easily support CircuitPython.

Just another documentation theme compatible with GitHub Pages
- For the first shuttle, we are starting small and verifying the USB core. The USB core is accompanied by simple audio and video output cores to fill in more of the user area.

## What it does?
- Future plans are to create a full featured VexRiscV core with SRAMs once the OpenRAM support is released.

This theme is inspired by [sphinx-rtd-theme](https://github.com/readthedocs/sphinx_rtd_theme) and refactored with:
# CIIC Harness

- [@primer/css](https://github.com/primer/css)
- [github-pages](https://github.com/github/pages-gem) ([dependency versions](https://pages.github.com/versions/))
- A template SoC for Google SKY130 free shuttles. It is still WIP. The current SoC architecture is given below.

## Quick start
<p align="center">
<img width="600" height="657" src="assets/images/ciic_harness.png">
</p>

```yml
remote_theme: rundocs/jekyll-rtd-theme
```
## License

You can [generate](https://github.com/rundocs/starter-slim/generate) with the same files and folders from [rundocs/starter-slim](https://github.com/rundocs/starter-slim/)

## Usage

Documentation that can guide how to create with Github pages, please refer to [rundocs.io](https://rundocs.io) for details

## Features

- Shortcodes (Toasts card, mermaid)
- Pages Plugins (emoji, gist, avatar, mentions)
- Auto generate sidebar
- [Attribute List Definitions](https://kramdown.gettalong.org/syntax.html#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 |

```yml
# 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
The theme is available as open source under the terms of the MIT License
4 changes: 2 additions & 2 deletions _config.yml
@@ -1,5 +1,5 @@
title: jekyll-rtd-theme
description: Just another documentation theme compatible with GitHub Pages
title: pyfive
description:

theme: null

Expand Down
Binary file added assets/images/ciic_harness.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
11 changes: 0 additions & 11 deletions test/README.md

This file was deleted.

17 changes: 0 additions & 17 deletions test/avatar.md

This file was deleted.

35 changes: 0 additions & 35 deletions test/codes.md

This file was deleted.

15 changes: 0 additions & 15 deletions test/emoji.md

This file was deleted.

37 changes: 0 additions & 37 deletions test/fonts.md

This file was deleted.

11 changes: 0 additions & 11 deletions test/gist.md

This file was deleted.

0 comments on commit 529d883

Please sign in to comment.