publicdomaincompany / Scroll

Static publishing software with a newspaper feel built on Tree Notation. Scroll is public domain software.

Projects that are alternatives of or similar to Scroll

Breakdance
It's time for your markup to get down! HTML to markdown converter. Breakdance is a highly pluggable, flexible and easy to use.
Stars: ✭ 418 (+102.91%)
Mutual labels:  markdown, markup
Pandoc Ruby
Ruby wrapper for Pandoc
Stars: ✭ 299 (+45.15%)
Mutual labels:  markdown, markup
Badges
📝 Markdown code for lots of small badges 🎀 📌 (shields.io, forthebadge.com etc) 😎. Contributions are welcome! Please add yours!
Stars: ✭ 2,987 (+1350%)
Mutual labels:  markdown, markup
Markup.rocks
Pandoc based document editor and converter in your browser.
Stars: ✭ 348 (+68.93%)
Mutual labels:  markdown, markup
Pandoc
Universal markup converter
Stars: ✭ 24,250 (+11671.84%)
Mutual labels:  markdown, markup
Preact Markup
⚡️ Render HTML5 as VDOM, with Components as Custom Elements!
Stars: ✭ 167 (-18.93%)
Mutual labels:  markdown, markup
Django Markupfield
📑 a MarkupField for Django
Stars: ✭ 184 (-10.68%)
Mutual labels:  markdown, markup
Hercule
♻️ Simple document transclusion, ideal for Markdown documents
Stars: ✭ 196 (-4.85%)
Mutual labels:  markdown
Jekyll Spaceship
🚀 A Jekyll plugin to provide powerful supports for table, mathjax, plantuml, mermaid, emoji, video, audio, youtube, vimeo, dailymotion, soundcloud, spotify, etc.
Stars: ✭ 196 (-4.85%)
Mutual labels:  markdown
Stickyfill
Polyfill for CSS `position: sticky`
Stars: ✭ 2,252 (+993.2%)
Mutual labels:  scroll
Markdown Pdf
📄 Markdown to PDF converter
Stars: ✭ 2,365 (+1048.06%)
Mutual labels:  markdown
Database
EhTagTranslation 项目的翻译数据。
Stars: ✭ 197 (-4.37%)
Mutual labels:  markdown
Portfolioexamples
(Resource List) - Portolio sites for inspiration and comparison
Stars: ✭ 201 (-2.43%)
Mutual labels:  markdown
Qimage Win
Windows 版本 Markdown 一键贴图工具,支持本地文件、截图、网络图片一键上传七牛云并返回图片引用,让 Markdown 中贴图变成一种享受。
Stars: ✭ 196 (-4.85%)
Mutual labels:  markdown
Symphony
🎶 一款用 Java 实现的现代化社区(论坛/BBS/社交网络/博客)平台。
Stars: ✭ 13,080 (+6249.51%)
Mutual labels:  markdown
Stickybits
Stickybits is a lightweight alternative to `position: sticky` polyfills 🍬
Stars: ✭ 2,220 (+977.67%)
Mutual labels:  scroll
Parsedown
Better Markdown Parser in PHP
Stars: ✭ 13,959 (+6676.21%)
Mutual labels:  markdown
Codebraid
Live code in Pandoc Markdown
Stars: ✭ 204 (-0.97%)
Mutual labels:  markdown
Markdown Link Check
checks that all of the hyperlinks in a markdown text to determine if they are alive or dead
Stars: ✭ 198 (-3.88%)
Mutual labels:  markdown
Bullets.vim
🔫 Bullets.vim is a Vim/NeoVim plugin for automated bullet lists.
Stars: ✭ 199 (-3.4%)
Mutual labels:  markdown

title 📜 Scroll: A new way to publish

paragraph

paragraph Scroll is simple static publishing software.

title2 Example site

paragraph

title4 What makes Scroll different?

paragraph Instead of a page per post, like a blog, a Scroll is a single page, like an old newspaper.

paragraph Instead of Markdown, Scrolls uses Tree Notation, which makes it easy to combine languages to generate more creative content.

paragraph Instead of supporting licenses, Scroll is 100% focused on public domain sites and everything is designed with that assumption.

title4 How do I get Scroll?

paragraph Scroll is scroll-cli on npm.

paragraph You can get it by typing:

code npm install -g scroll-cli

title4 How do I use Scroll?

paragraph Scroll is used through the CLI. To see the options type:

code scroll help

title4 Where do I get help?

paragraph Post an issue in this GitHub, join the Tree Notation subreddit or email Breck.

title4 What are some example sites using Scroll?

paragraph On beta launch day we have:

link https://breckyunits.com BreckYunits.com

title4 How does Scroll work?

paragraph A Scroll is a single folder containing Scroll files. Scroll compiles those Scroll files into a static index.html page.

paragraph Scroll is also the name of the command line app that includes a simple Node.js Express app for live preview.

paragraph Scroll is also the name of a Tree Language defined in this grammar.

title4 What does a typical project folder look like?

paragraph A typical Scroll project folder looks like this:

code yourProject/ someDraft.scroll readme.scroll yourDomainName.org/ about.scroll publishedArticle.scroll anImageInTheArticle.png index.html scrollSettings.map

paragraph The scrollSettings.map file let's Scroll know that a folder contains a Scroll.

paragraph When you "build" a Scroll site, you are simply generating the index.html and article*.html files in the site's folder.

paragraph The suggested project layout above let's you easily separate drafts from published content and put all under version control.

paragraph With Scroll your site's public static files, generated html, and published article source Scroll files, are all in the public folder and checked into version control.

title4 How do I save drafts?

paragraph Save them outside your public folder like in the sample project folder above.

title4 What File Formats does Scroll use?

paragraph Scroll articles are written as Scroll files with the file extension scroll. The grammar for Scroll is fully defined here

paragraph Entire Scrolls are saved as stamp files with the extension stamp.

title4 What languages is Scroll written in?

paragraph The Scroll app is written in plain Javascript and runs in Node.js.

paragraph Scroll makes heavy use of Tree Languages. The CSS is written in Hakon. The HTML is written in stump.

paragraph TypeScript may be used in the future but Scroll may never get over 1kloc so that might not be necessary.

title4 How does versioning of articles work?

paragraph Scroll is designed for git. A single article is stored as a single file tracked by git.

title4 Why is Scroll a single page?

paragraph Being able to scan the page like a newspaper is a very fast reading experience. This is central to Scroll.

paragraph Additionally, making it easy to take the content with you, and transform it to better suit the reader, is also key to Scroll.

paragraph Because Scroll is designed for public domain sites, we can optimize for the single page reading experience but people can have the full Scroll contents and render it however best suits them.

title4 Will you make design decisions for non-public domain sites?

paragraph No.

title4 Can I use Scroll for internal private sites not intended for publishing?

paragraph Yes!

title4 Will you support publishing snippets?

paragraph No. But will support making it easier for someone to do that in a fork or via plugins.

title4 Will you support newest articles flowing right to left instead of having potentially older articles up top?

paragraph No. But will support making it easier for someone to do that in a fork or via plugins.

title4 What were some alternatives considered?

paragraph There was no publishing software that reads and writes Scroll yet so building Scroll was necessary. Jekyll and Brecksblog are 2 biggest inspirations.

link https://jekyllrb.com/ Jekyll link https://github.com/breck7/brecksblog Brecksblog

title4 What has changed in recent versions?

code Version 6.0.0 released on 03-08-2021 By popular request, Scroll now also publishes each article to its own page. Removed the about links. Do less. KISS. Fixed horrible perf bug. "permalink" is now a scroll keyword. Version 5.0.0 released on 02-28-2021 changed name of everything from dumbdown to Scroll per user feedback BREAKING file extension of articles needs to be "scroll" and not "dd" now. Version 4.2.0 released on 02-22-2021 fixed paragraph parsing and rendering Version 4.1.0 released on 02-22-2021 added a "git" scrollSetting for article source links.

title4 Is there a place I can play with the Scroll grammar and see how it compiles to HTML?

link https://jtree.treenotation.org/designer#url%20https%3A%2F%2Fscroll.publicdomaincompany.com%2Fscroll.grammar Yes. In the Tree Language Designer.

Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].