https://github.com/brucou/hexo-tag-margin-note
https://github.com/brucou/hexo-tag-margin-note
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/brucou/hexo-tag-margin-note
- Owner: brucou
- License: mit
- Created: 2019-05-21T15:40:45.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2019-05-21T16:41:13.000Z (over 6 years ago)
- Last Synced: 2025-06-16T19:08:05.450Z (4 months ago)
- Language: JavaScript
- Size: 2.93 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# hexo-tag-scripture
A Hexo tag plugin to add margin notes to the right side of a document. Follows https://edwardtufte.github.io/tufte-css/
# Sidenotes: Footnotes and Marginal Notes
One of the most distinctive features of Tufte’s style is his extensive use of sidenotes.This is a sidenote.Sidenotes are like footnotes, except they don’t force the reader to jump their eye to the bottom of the page, but instead display off to the side in the margin. Perhaps you have noticed their use in this document already. You are very astute.
Sidenotes are a great example of the web not being like print. On sufficiently large viewports, Tufte CSS uses the margin for sidenotes, margin notes, and small figures. On smaller viewports, elements that would go in the margin are hidden until the user toggles them into view. The goal is to present related but not necessary information such as asides or citations _as close as possible_ to the text that references them. At the same time, this secondary information should stay out of the way of the eye, not interfering with the progression of ideas in the main text.
## Installation
```
npm install --save hexo-tag-margin-note
```
## Docs, TL;DR-Style
**Scripture Blockquotes**
```markdown
{% margin %}
The **text**
{% endmargin %}
```
becomes
```html
??
```
## Documentation
N/A
you need the css which goes with it. Cf. https://github.com/edwardtufte/tufte-css
### Common Options
N/A
## Example
N/A
## License
[MIT](LICENSE)