AramZS / notebook

Repo where my live public-facing notebook lives.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

aliases public
Note Publisher
NotePub
NotePublisher
Notebook
true

Notebook

tags:: #fellowship-of-the-link #six-tools up:: [[FellowhipOfTheLink|Fellowship of the Link]] [[shared-notes-across-six-tools|Shared Notes Across Six Tools]]

A tool to publish those notes here that are intended to be public facing.

Directives for Parsing and Build:

YAML

  • define: Show the Wikipedia definition
  • public: This note is intended to be published.
    • Notes marked false or with no value will never have any part published.
    • Notes marked true will have their whole body published along with metadata.
    • Notes marked partial-public will have any :::{public} content ::: content blocks published and no metadata other than title.
    • Notes marked partial-private will have all content except for :::{private} content ::: content blocks published and all metadata.
    • Notes marked true will also follow the private directives.
  • mainlink: This note is referring to a URL as its primary subject.
  • go: This link defines the page, it is intended to be a forwarding link.
  • isBasedOn: This page is a direct other page and should be considered a replica or summary of that page.
  • date: intended publishing time. If none is given, it is considered to be have a value of "Now"
  • aliases: YAML list of other ways to refer to this page besides filename.
  • republish: Designate a YAML list of TLDs or source list names which you wish to republish to. Processing of a republish event is up to the receiving site and may be an entirely new page or the absorption of the page into an existing page, or a denial.
  • tags: to add keywords in a YAML list.
  • moved-to: Indicates this note file has been moved to a public-facing URL and that is the resource that should be accessed instead.
  • moved-date: Indicates the date at which this file was moved to the public-facing URL. It never occurs without moved-to.

Folder Structure

  • A folder indicates hierarchy that indicates the contained pages should be considered a child of the Folder-as-a-page and that the Folder-as-a-page can list the down pages.
  • Any folder may have a relative images, Images, or img folder.

Metastatements

  • All meta statements are a single word ending in ::
  • tags:: add to keywords
  • up:: hierarchy that indicates this page should be considered a child of the listed pages and that the up pages can list the down pages.
  • down:: hierarchy that indicates this page should be considered a parent of the listed pages.
  • include:: Comma separated URL link of passed resources to be embedded at the end of the current link.
  • circle:: Peer pages that are associated but not hierarchical. Order is irrelevant, but alphabetical is assumed.

Conventions

Interlinked

  • Includes Context.center links as sources, adds them as searchable.
  • Creates pages from Linked terms with a list of links that match that term.
    • If this page is only a single link, consider that link to be the same as isBasedOn
  • Links should include checking for - and _ versions of the link.
  • Pull in archive somehow? #pull creates an archive?
  • Pull in any public Google Doc as text for the page?
  • Establish list of sources
    • Where those sources have url/matched-path - pull that source in as a link and potentially a node for the matched path on my own site.
    • Can also establish a source name and use it as a path/selector: [@rel8/foo] where @ points to a listing in the sources list.
    • Agora source links: agora/sources.yaml at master · flancian/agora · GitHub
    • Establish a URL resolution alias file for internal/external use?

Outputs

  • RSS feed of new pages
  • JSON API for page list?
  • JSON statement for url paths index.html and index.json
  • Raw MD version for url paths index.html and index.md

Useful Specs

About

Repo where my live public-facing notebook lives.


Languages

Language:Rust 99.8%Language:Shell 0.2%