Metadata-Version: 2.1
Name: carbonado
Version: 1.0.3
Summary: The best documentation framework every created.
License: GPL 3.0
Project-URL: GitLab, https://gitlab.com/offline-money/squash-1/carbonado
Description-Content-Type: text/markdown
Requires-Dist: onesie
Requires-Dist: law_dictionary
Requires-Dist: clique
Requires-Dist: esprima
Requires-Dist: mako
Requires-Dist: flask
Requires-Dist: jsonschema
Requires-Dist: rich




******

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](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](https://developer.mozilla.org/en-US/docs/Web/HTML/Viewport_meta_tag)  

and support for UTF-8 characters.    
[http://www.unicode.org/charts](http://www.unicode.org/charts)    
[https://www.w3.org/International/questions/qa-html-encoding-declarations]([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',
		'.6.HTML',
		'.6.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
bgrace2345@proton.me

