Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gnat/sublime-outline-notes-publisher
✒️ Publish HTML from markdown or tab indented notes. Static site generator in Sublime Text! Alternative to Obsidian.
https://github.com/gnat/sublime-outline-notes-publisher
indentation list markdown note-taking notes obsidian outliner outliners roamresearch static-site static-site-generator sublime-plugin sublime-text sublime-text-plugin tabs whitespace wiki zettelkasten
Last synced: 2 months ago
JSON representation
✒️ Publish HTML from markdown or tab indented notes. Static site generator in Sublime Text! Alternative to Obsidian.
- Host: GitHub
- URL: https://github.com/gnat/sublime-outline-notes-publisher
- Owner: gnat
- License: mit
- Created: 2022-05-19T05:54:30.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-01-12T20:28:53.000Z (about 2 years ago)
- Last Synced: 2023-03-30T15:59:05.691Z (almost 2 years ago)
- Topics: indentation, list, markdown, note-taking, notes, obsidian, outliner, outliners, roamresearch, static-site, static-site-generator, sublime-plugin, sublime-text, sublime-text-plugin, tabs, whitespace, wiki, zettelkasten
- Language: Python
- Homepage:
- Size: 87.9 KB
- Stars: 8
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ✒️ Sublime Outline Notes Publisher
Publish HTML pages using tab indented notes or markdown (md)! It's Obsidian in Sublime Text. 🔥
Zero dependency publishing from the comfort of your code editor.
Perfect for:
* Note takers who love using tab indentation / whitespace for organization.
* Static site generator for personal sites, blogs, micro wiki.
* Zettelkasten
* Replacing your outliner with Sublime Text.
* What is an [Outliner](https://en.wikipedia.org/wiki/Outliner)?
## Publish HTML Pages ...
## Using your hierarchy aware notes!
````
All you have to do...
Is create an indented hierarchy.
Of your notes.
In a list.
It will create a nice HTML file...
With a hierarchy based on indent levels.
Isn't this convenient?
Whitespace significant outliner style notes!
Other cool outliners:
[Bike](https://news.ycombinator.com/item?id=31409077)
Dynalist
[Obsidian](https://obsidian.md)
[Obsidian Publish](https://obsidian.md/publish)
Workflowy
Roam Research
Notion
Standard Notes
Evernote
Ever-who? 🐘
Only for:
Sublime Text (https://sublimetext.com)
Super Nintendo
🔥 Great plugin for
Note taking.
Outlining.
Zero dependency publishing.
🚧 Code blocks!
```javascript
document.addEventListener("click", ev => {
alert("You selected the following element: " + ev.target)
})
```
✅ Common markdown / markup syntax.
# Header 1 line
## Header 2 line
* Emphasis line
** Bold line
### Images with img
### Global and Local Links. Plain, named and pure HTML links.
http://github.com/gnat/sublime-outliner-html
🔗 [Local named link!](/local_link) 🌐 [Global named Link!](http://google.com) https://google.com Pure HTML link!
💬 Comments.
// I will not be in the HTML file.
🏗️ Comments to insert structural metadata.
//title I will be added to ▶️ ▶️
````
## Installation
Option A: `Preferences` ➡️ `Package Control` ➡️ `Install Package` ➡️ `Outline to HTML` ➡️ ENTER
Option B (Direct): `Preferences` ➡️ `Browse Packages ...` ➡️ [Download and extract the latest.](https://github.com/gnat/sublime-outline-notes-publisher/archive/refs/heads/main.zip)
## How to use
1. Select text you want to convert.
2. `CTRL+SHIFT+P` ➡️ `Outline to HTML`
3. The resulting HTML will open in a new tab.
Supported languages for [code blocks](https://prismjs.com/#supported-languages) powered by [Prism.js](https://prismjs.com).
## Global Configuration (Optional)
Configure using Preferences ➡ Settings
```js
{
// ...
"outline_to_html": {
// "css": "", // Override CSS.
// "title": "", // Override Title (or use meta comment //title ...)
// "header": "", // Add to
// "body": "", // Add to
// "footer": "", // Add before
}
}
```
## Roadmap
* Automatic table of contents.
* More metadata comments.
## Suggested Sublime Color Schemes
* [Invader Zim](https://github.com/gnat/sublime-invader-zim) 🛸
## Other Cool Outliners / Bullet Point Note Software
* [Bike](https://www.hogbaysoftware.com/bike/)
* [Dynalist](https://dynalist.io/)
* [Obsidian Publish](https://obsidian.md/publish)
* [Workflowy](https://workflowy.com/)
* [Roam Research](https://roamresearch.com/)
* [Notion](https://www.notion.so/)
* [Standard Notes](https://standardnotes.com/)
* [Evernote](https://www.evernote.com/)
## Troubleshooting
* `View` ➡️ `Show Console`
* Manually invoke for development: `view.run_command('outline_to_html')`
## Special Thanks
* Harrison of [Indent.txt](https://github.com/Harrison-M/indent.txt) for the inspiration for such a plugin.