https://github.com/bmacho/sbviewer

nbviewer-like website for opening Starboard Notebooks from github, gist, or any other place
https://github.com/bmacho/sbviewer

literate-programming notebook starboard starboard-notebook

Last synced: 3 months ago
JSON representation

nbviewer-like website for opening Starboard Notebooks from github, gist, or any other place

• Host: GitHub
• URL: https://github.com/bmacho/sbviewer
• Owner: bmacho
• License: mpl-2.0
• Created: 2021-10-30T15:17:00.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2021-11-06T08:34:23.000Z (about 3 years ago)
• Last Synced: 2024-06-21T13:32:55.523Z (5 months ago)
• Topics: literate-programming, notebook, starboard, starboard-notebook
• Language: HTML
• Homepage: https://bmacho.github.io/sbviewer/
• Size: 23.4 KB
• Stars: 4
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-starred - bmacho/sbviewer - nbviewer-like website for opening Starboard Notebooks from github, gist, or any other place (others)

README

        
# sbviewer

**What's this?** 

A viewer for [Starboard](https://starboard.gg/) files hosted on github/gist, in the spirit of [nbviewer](https://nbviewer.org/) for jupyter files. 

**How to use it?** 

Just open/share 

https://bmacho.github.io/sbviewer/?sb=PATH

type links. 

- For notebooks hosted on gist, the syntax is

https://bmacho.github.io/sbviewer/?sb=gist/USER/GISTNUMBER/?revision/?file 

where both revision and file name are optional. If there are multiple files in a gist, it will open the first one. E.g. for the gist https://gist.github.com/bmacho/67188d770d96b050ea329991b3cbe898/ you can do 

  - https://bmacho.github.io/sbviewer/?sb=gist/bmacho/67188d770d96b050ea329991b3cbe898/procedural-art.sb or

  - https://bmacho.github.io/sbviewer/?sb=gist/bmacho/67188d770d96b050ea329991b3cbe898/e9a4c960b371ac3136b9afc7765abf51565f868c/README.md

- For notebooks hosted on github, the syntax is 

https://bmacho.github.io/sbviewer/?sb=github/USER/REPO/"blob"/BRANCHorCOMMIT/FILEPATH e.g. in this repo : 

  - https://bmacho.github.io/sbviewer/?sb=github/bmacho/sbviewer/blob/main/README.md

  - https://bmacho.github.io/sbviewer/?sb=github/bmacho/sbviewer/blob/09be7302b55262066ac9fb8bb05332133be69af6/README.md

- You also can use any other URL that your browser can get, http urls, or relative paths. e.g.:  

  - https://bmacho.github.io/sbviewer/?sb=README.md

should open README.md in the same folder: https://bmacho.github.io/sbviewer/README.md . You can use this if you place the index.html file in a local folder (needs a webserver because of CORS), or on an own website (e.g. github pages).

**Features/automatisms**

- If the file extension is md/js, it creates a markdown/javascript cell. (Does not recognise the file type, if there is no extension.)

- Trims down trailing newline characters from the last cell, because my text editor attaches to the ends of files, and it looks ugly when opened. 

- If no sb source given, it defaults to index.sb

- 404 notebook: https://bmacho.github.io/sbviewer/?sb=github/bmacho/sbviewer/blob/main/VALID_NOTEBOOK_PATH_BUT_NOTHING_HERE

### License 

It's a very slightly modification of starboard-notebook, both the original, and all of my modification are licensed under MPL2.