Skip to content

hotoku/fosi

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

120 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

fosi

livereloading server for markdown editing

usage

usage

Run this command.

$ fosi -i document.md

Then,

  1. A process starts watching your document.md and automatically compiles it to html when updated.
  2. The compiled html is served at http://localhost:3000/ and the file will be reloaded when it is updated.
  3. The files in the folders under the one where document.md exists are also watched and served, your browser will reload when these files are updated.

Other command line options are following:

Options:
      --help     Show help                                             [boolean]
      --version  Show version number                                   [boolean]
  -i             input file                                  [string] [required]
  -d             output file                  [string] [default: "./index.html"]
  -f             overwrite existing output                             [boolean]

install

$ npm i -g @hotoku/fosi

for use from emacs (optional)

This repo includes very simple function that launches a fosi process from Emacs. The source file is here.

You can install the elisp by the following steps.

  1. Download the raw file from github. eg. curl -o /tmp/fosi.el https://raw.githubusercontent.com/hotoku/fosi/main/elisp/fosi.el
  2. Install the file by invoking M-x package-install-file and input the path you downloaded in the previous step.
  3. Put (require 'fosi) in your init.el.

license

This software is published under MIT license.

credit

About

livereloading server for markdown editing

Resources

Stars

Watchers

Forks

Releases

Packages

Used by

Contributors

Languages