@onlabsorg/stilo

    0.17.1 • Public • Published

    stilo

    This is a command line tool for managing olojs documents; out of the box it allows creating new document packages, rendering documents and serving documents over HTTP.

    If you are not yet familiar with olojs documents, you can get started with this introduction.

    Getting started

    Install stilo globally.

    npm install @onlabsorg/stilo -g
    

    Initialize a new library:

    cd /path/to/my-library
    stilo init
    

    Render a document contained in my-library:

    stilo render /path/to/doc
    

    You can optionally inject parameters in the document context by adding key=value pairs after the path

    stilo render /path/to/doc p1=val1 p2=val2 p3=val3 ...

    The passed parameters will be added to the document context under the __query__ namespace (query={p1:val1, p2:val2, p3:val3, ...}).

    Your local olojs documents are text files with .olo extension, but you must omit the extension when specifying a document path.

    Serve the library over http:

    stilo run server
    

    Once the HTTP server is running, your document source will be accessible at the URL http:/loclahost:8010/home/path/to/doc.

    Of course, with the same command, you can even serve your documents over the internet.

    For a full description of the commands available, read the cli documentation.

    Plugins

    Plugins are npm packages that can decorate the stilo store and/or add custom sub-commands to the stilo CLI.

    In order to install a plugin, you use the stilo install command, followed by the name of the npm package that contains the plugin.

    stilo install <plugin-name>
    

    In order to uninstall a plugin, you use the stilo uninstall command, followed by the name of the npm package that contains the plugin.

    If you are a developer and you want to create your own plugin or customize the way a package behaves, check the package documentation.

    Cooperation

    Any stilo package you create is a folder containing olojs documents, which are just text files with .olo extension, organized in sub-folders as you please.

    By their nature, the olojs documents contained in you package can import each other and re-use each-other's content, which makes your stilo package a personal content management system.

    Wouldn't it be great if you could use also other people's documents, the same way programmers use open-source libraries created by others, allowing for collaborative editing of documents? Of course that's possible and there are several ways to do that:

    • Git it! Being your package just a bunch of text files, you can use Git to version-control them and cooperate on them.
    • Access remote documents via HTTP/HTTPS! Each of your packages mounts by default two schemes http:/ and https:/. You can use those paths to fetch/load/import documents from anywhere on the web. For example, try stilo render https://raw.githubusercontent.com/onlabsorg/olojs/master/test/public/greet.olo.
    • Access remote documents via IPFS! (Requires the [ipfs-store] plugin)
    • Install a third party stilo library! It is possible for people to publish olojs document libraries on npm and for you to install them and mount them to a path of your local package via stilo install <library-npm-package>. To be clear, as far as I know, nobody has published such a library yet (not even me), but I will update this documentation as soon as someone does.
    • Share a sub-folder for concurrent editing! This can be done via DropBox, GoogleDrive, Hypercore, etc.
    • Install a cooperation plugin! The stilo plugin system is really flexible and someone (maybe you) may some day create a proper plugin to ease cooperative olojs documents editng.

    License

    This software is released under the ISC license.

    Related projects

    • olojs is a distributed content management system
    • olowiki is a web interface that allows creating and modifying youd olojs documents (it includes also a stilo plugin)

    Install

    npm i @onlabsorg/stilo

    DownloadsWeekly Downloads

    46

    Version

    0.17.1

    License

    ISC

    Unpacked Size

    31.4 kB

    Total Files

    14

    Last publish

    Collaborators

    • onlabsorg