README
¶
iview: Instant View local HTTP server
iview is an HTTP server that serves the contents of a local directory. When serving, it applies templates and filters depending on the file type. This makes it function as a pseudo file explorer or file viewer. Additionally, the file viewer has an auto-reload feature.
Direcotry Structure for Resources
The resource direcotry (_resource) provides two fs.FSs: static and template
staticdirectory provides static resources.templatedirecotry provides templates.layout.htmlis the root layout template.- others: templates for media types.
The resource directory is normally exposed via embed.FS, but the physical file system can be used for debugging purposes using the -rsrc option.
Misc.
- You can open a file in an editor. The editor can be specified with the
-editorflag, or the environment variablesIVIEW_EDITORandEDITOR. The priority is as described above.
Developer Resources
-
Inspect shared workers in Chrome
chrome://inspect/#workersCopy the URL above. For security reasons, it cannot be opened as a link.
-
- Guide: https://developers.google.com/fonts/docs/material_symbols
- CSS base
_resource/static/thirdparty/material-symbols.css:
https://fonts.googleapis.com/css2?family=Material+Symbols+Outlined - Font file
_resource/static/thirdparty/material-symbols.woff2:
https://fonts.gstatic.com/s/materialsymbolsoutlined/v257/kJF1BvYX7BgnkSrUwT8OhrdQw4oELdPIeeII9v6oDMzByHX9rA6RzaxHMPdY43zj-jCxv3fzvRNU22ZXGJpEpjC_1v-p_4MrImHCIJIZrDCvHOej.woff2
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
fsmon
command
|
|
|
gitstatus
command
|
|
|
internal
|
|
|
browser
Package browser provides utilities for interacting with users' browsers.
|
Package browser provides utilities for interacting with users' browsers. |
|
fschanges
Package fschanges provides HTTP server that streams change events on a filesystem.
|
Package fschanges provides HTTP server that streams change events on a filesystem. |
|
fsmonitor
Package fsmonitor monitors change events in the specified directory.
|
Package fsmonitor monitors change events in the specified directory. |
|
gitfunc
Package gitfunc provides wrappers for the functions of go-git that iview uses.
|
Package gitfunc provides wrappers for the functions of go-git that iview uses. |
|
highlight
Package highlight provides/wraps syntax highlighting feature.
|
Package highlight provides/wraps syntax highlighting feature. |
|
pubsub
Package pubsub provides simple pub/sub feature.
|
Package pubsub provides simple pub/sub feature. |
|
templatefs
Package templatefs provides Template set.
|
Package templatefs provides Template set. |
|
Package layout provides layout mechanism for iview
|
Package layout provides layout mechanism for iview |
|
dto
Package dto provides Data Transfer Object for layout system.
|
Package dto provides Data Transfer Object for layout system. |
|
Package plugin provides extensible ponits of iview.
|
Package plugin provides extensible ponits of iview. |
|
gitinfo
Package gitinfo provides git information.
|
Package gitinfo provides git information. |
|
markdown
Package markdown provides markdown plugin for iview.
|
Package markdown provides markdown plugin for iview. |
|
octetstream
Package octetstream provides a layout for iviews that display dumps of application/octet-stream files.
|
Package octetstream provides a layout for iviews that display dumps of application/octet-stream files. |
Click to show internal directories.
Click to hide internal directories.