The best documentation framework every created.
Project description
Bravo! You have received a Mercantilism Diploma in "carbonado" from
the Orbital Convergence University International Air and Water
Embassy of the Tangerine Planet (the planet that is one ellipse further from
the Sun than Earth's ellipse).
You are now officially certified to include "carbonado" in your practice!
Encore! Encore! Encore! Encore!
carbonado
description
Started from the shell, "carbonado" presents files in the current working
directory (CWD) that have extension ".6.HTML" (case sensitive).
obtainment
[xonsh] pip install carbonado
tutorial
[xonsh] carbonado carbonado
the shell interface
[xonsh] carbonado
"carbonado" starts on port 2345, or the first avaible port after that.
- Running on http://127.0.0.1:2345
This is the equivalent of:
[xonsh] carbonado start --port 2345
--
Alternatively you can add --static-port and "carbonado"
stops if the port specified is unavailable.
[xonsh] carbonado start --port 2345 --static-port
--
This is an example ".6.HTML" file.
<pre>
<h1>This is an example HTML file.</h1>
<p>
It really only needs the "pre" tag to
look like a reflection of its contents in a browser.
</p>
<p>
Tags like "html" and "body" are actually not
necessary for rendering HTML in modern browsers.
</p>
<p>
for text to wrap, instead of extending off the page,
style "white-space: pre-wrap" can be utilized instead of
a "pre" tag like so:
<div style="white-space: pre-wrap"></div>
</p>
</pre>
However, here is the "CSS1Compat" option,
https://developer.mozilla.org/en-US/docs/Web/HTML/Quirks_Mode_and_Standards_Mode
with scaling based on the browser screen "viewport" of the screen,
https://developer.mozilla.org/en-US/docs/Web/HTML/Viewport_meta_tag
and support for UTF-8 characters.
http://www.unicode.org/charts
https://www.w3.org/International/questions/qa-html-encoding-declarations
<!doctype html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
</head>
<body>
<main>
<article style="white-space: pre-wrap">
</article>
</main>
</body>
</html>
the python3 interface
import pathlib
from os.path import dirname, join, normpath
this_folder = pathlib.Path (__file__).parent.resolve ()
import carbonado
carbonado.start ({
"extensions": [
'.6.HTML',
'.$.HTML',
'.S.HTML',
'.s.HTML',
'.jpg',
'.png'
],
#
# This is the node from which the traversal occur.
#
"directory": str (this_folder) + "/structures/carbonado",
#
# This path is removed from the absolute path of share files found.
#
"relative path": str (this_folder) + "/structures/carbonado",
#
# The first port to check
#
"port": 2345,
#
# Whether to check more ports if port is unavailable
#
"static port": False,
#
# 0, 1, 2
#
"verbose": 1,
})
import time
while True:
time.sleep (1000)
contacts
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file carbonado-1.0.4.tar.gz.
File metadata
- Download URL: carbonado-1.0.4.tar.gz
- Upload date:
- Size: 23.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.10.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 28db271b8f9ee9e9e3430d90ef402c5a33595b47118799b37b6fbdda00109a24 |
|
| MD5 | bb7fba94c96c9b4f8a1652e61620e6b3 |
|
| BLAKE2b-256 | f32d14a34e627c8616d78c6a3e7d3ed12d90099c313c44cc94f659b4732cbe08 |
File details
Details for the file carbonado-1.0.4-py3-none-any.whl.
File metadata
- Download URL: carbonado-1.0.4-py3-none-any.whl
- Upload date:
- Size: 23.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.10.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 35aad298ab3c8fecea259309dccd865cef5deefab2e732cc5c79f5719b8a95e0 |
|
| MD5 | 44e9b51716ab9ccb520fa4d6bf5e549e |
|
| BLAKE2b-256 | 65e3e4208e1a3487f37852ac22ebdbe9a6547d92a8fd6421badfe355f699e51d |
