Skip to content

Commit

Permalink
docs: readme
Browse files Browse the repository at this point in the history
  • Loading branch information
chollinger93 committed Jun 20, 2023
1 parent 661cd79 commit 96514b6
Show file tree
Hide file tree
Showing 6 changed files with 21 additions and 6 deletions.
27 changes: 21 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,9 @@ This repository is a purely local (i.e., no CDNs[^1]), simplified version of `hu
As well as some additional **features**:
- Added a Back button to all posts
- Added a Table of Contents (TOC), controlled by a variable, to all posts
- The TOC can either be static at the beginning of the article
- The TOC can either be static at the top
- Or floating on the side
- Or both
- TOC can also be auto-truncated to only show `h1`/`h2` headings

- Added a word count, tags, and an approximate read time to the overview
- Added random footer messages
- Added "Edit this on GitHub" button
Expand All @@ -36,13 +35,29 @@ And some **bugfixes**:

![Screenshot](https://raw.githubusercontent.com/chollinger93/ink-free/master/images/screenshot.png "Ink-Free theme")

![Screenshot](https://raw.githubusercontent.com/chollinger93/ink-free/master/images/screenshot2.png "Ink-Free theme")
![image-20230620151830930](images/screenshot2.png)

### Table Of Contents Options

### Static vs Floating TOC
#### Floating

![image-20230620114414684](images/floating_toc.png)

![image-20230620114454738](images/static_toc.png)
#### Static

![image-20230620151300448](images/static_toc.png)

#### Both

![image-20230620151006141](images/both_toc.png)

#### Truncated

![image-20230620151110164](images/truncated_toc.png)

#### Mobile

![image-20230620151645609](images/mobile_toc.png)

### Run the example
```
Expand Down
Binary file added images/both_toc.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/mobile_toc.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/screenshot2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/static_toc.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/truncated_toc.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 96514b6

Please sign in to comment.