About SPB

SPB promotes a "best-patterns" approach to Documentation by:

Use-cases

Micro "How-To"

  1. Install a light-weight web (HTML) server on your PC.
    An simple way is to download and install python 3. Then from the terminal (Linux/Mac) or the command prompt (Windows) execute next 3 commands and press Enter key( ⏎ ) to confirm.
    Command to execute:                          Explanation
    C:\users\myUser > mkdir project01⏎     ←···· [m]a[k]e (or create) new [dir]ectory
                                                 where the page will be stored
                                                
    C:\users\myUser > cd    project01⏎     ←···· [c]hange [d]irectory
    
    C:\users\myUser > python3 -m http.server⏎  ← Execute safe web server pointing
                                                 (only our computer will be able to
                                                  access the content server)
           
  2. Copy next files to the directory where pages will be placed:
            map_template.html
            map_v1.css
            map_v1.js
            custom.js
            
    Rename map_template.html to provide a sensible name. All others files just need to be downloaded once. They will be reused again and again.
    "map_v1.js" contains the minimum Javascript code used to navigate and react to user actions.
    "map_v1.css" contains the Cascading Style Sheets to "beautify" the content.
    "custom.js" allows advanced customization. Just leave it next to the other files and forget.
  3. Point your browser to http://localhost:8000 and click in you renamed template html file.
    Note that localhost is an special safe and private address pointing to your local computer.
    Nobody outside your computer can access it.
    More info [here].
  4. Congratulations! You are done. Now it's time to add notes by just adding some html blocks tagged with zoom and labels attributes.
    Reload your web page to see the results. Play around until you feel comfortable and get ready to take control of your information Forever!!!.

Next steps

Features

Gallery of SPB Books

Planned Features

Planned (far) Features

Apropos