Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .eslintignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
/node_modules
/adorn.js
/adorn_sw.js
/_site
50 changes: 48 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,59 @@

Adorn is a theme for *plain* markup. It aims to make unstyled HTML much more user friendly with minimal fuss. Simply include a style and a script into the document.

Take a look at the simple source of this page [right click view source]

It comprises of two external files:

- `/adorn/adorn.css` Basic style for plain markup
- `/adorn/adorn.js` Navigtational UI Components, etc...

Take a look at the simple source of this page [right click view source]


## Options

Adorn will derive options from a few places

- A [Web App Manifest](https://developer.mozilla.org/en-US/docs/Web/Manifest)
If a Link tag such as `<link rel=manifest href=/app/manifest.json />` can be found it will load the address defined there or take a bet on it being in the root at `/manifest.json`, but if neither exists it'll carry on regardless.

- Document overides come from `<meta>` tags with a matching `name` property.



Default site Favicon to be put into page

"favicon" : "/favicon.ico",

Github name or name/repo for linking through, edit options

"github" : "MrSwitch",

Twitter sharing link

"twitter:creator" : "@setData",

Shoutout message appears in top right of navbar

"shoutout": "Adorn: <i>make more beautiful or attractive.</i>",

Footer Author link

"author" : "Andrew Dodson, https://adodson.com",

Serviceworker URL to register.

"serviceworker": "./adorn_sw.js",

Fallover, page to show when offline

"fallover" : [{
"mode": "navigate",
"fallover": "/offline.html"
}],





## Rules

Expand Down
2 changes: 1 addition & 1 deletion adorn.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion adorn.js.map

Large diffs are not rendered by default.

2 changes: 2 additions & 0 deletions adorn_sw.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions adorn_sw.js.map

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
"type" : "image/png"
}],
"display": "standalone",
"serviceworker": "./adorn_sw.js",
"orientation": "portrait-primary",
"favicon" : "/favicon.ico",
"github" : "MrSwitch",
Expand Down
Loading