Lightweight markup for colored documents.
- Simple, concise and consistent syntax to quickly write colored documents.
- Complete :
- styles, colors, sizes, classes, alignments
- spans, blocks, boxes, frames, quotes, tables
- titles, lists, links, images, line and page breaks
- Source code syntax highlighting.
- Fast conversion to HTML by a standalone command line tool or by a web browser script.
- The generated files can be imported in LibreOffice Writer.
Install the Pendown installation files in a local folder on your computer.
Open the "sample.html" file with any plain text editor, like Geany or Notepad++.
It shows the available Pendown tags. They are converted to HTML tags when the file is opened in a web browser.
<meta charset="utf8"/>
<link rel="stylesheet" href="../pendown.css">
<xmp>
**Pendown** tags are automatically converted into **HTML** tags when the file is opened in a web browser.
---
! Giant Title
!! Huge title
!!! Big title
!!!! Large title
!!!!! Medium title
!!!!!! Small title
!! Line break
Manual line break§
inside a paragraph.
Another paragraph.
!! Page break
~~~
This is printed on a new page.
!! Escape
\_\_
`** <b>not bold</b> **`
!! Alignment
<<left<<
$$center$$
>>right>>
!! Styling
**bold**
%%italics%%
^^superscript^^
,,subscript,,
~~strikethrough~~
~~^#f00\strikethrough~~
__underlined__
__^#f00\underlined__
##highlighted##
##^#fce\highlighted##
{{^#6f42c1\colored}}
{{^#0cc\colored}}
{{^#f4f\^1.25\colored}}
{{^#80f\^large\colored}}
{{^cyan\colored}}
{{^pink\^1.25\colored}}
{{^blue+large=blue_large\colored}}
{{^blue_large+bold\colored}}
°°black°°
¹¹cyan¹¹
²²orange²²
³³green³³
°gray°
¹pink¹
²red²
³blue³
!! Block
{{{^pastel_gray_fill\
Block
}}}
{{{^#cfe\
Block
}}}
{{{^#cfe\^black\
Block
}}}
!! Box
###
Box
###
###^#cfe\
Box
###
###^#cfe\^black\
Box
###
!! Frame
+++
Frame
+++
+++^#f00\
Frame
+++
{{{^#ffd\
+++^#f00\
Frame
+++
}}}
{{{^#ffd\
+++^#f00\^black\
Frame
+++
}}}
!! Quote
>>>
Quote
>>>
>>>^#f00\
Quote
>>>
{{{^#ffd\
>>>^#f00\
Quote
>>>
}}}
{{{^#ffd\
>>>^#f00\^black\
Quote
>>>
}}}
!! Table
[[[
(( | Monday | Tuesday | Wednesday ))
(( Apple | 1 | 2 | 3 ))
(( Orange | 1 | 2 | 3 ))
(( Banana | 1 | 2 | 3 ))
]]]
{{^orange+bold=²\}}
[[[^orange_border+tiny_border+padding+black=table\
((^orange_fill+white+bold+center=title\^=2\ Subject pronouns ))
(( ²yo² | I ))
(( ²tú² | you ))
(( ²él², ²ella², ²usted² | he, she, %%you%% ))
(( ²nosotros², ²nosotras² | we ))
(( ²vosotros², ²vosotras² | you ))
(( ²ellos², ²ellas², ²ustedes² | they, %%you%% ))
]]]
[[[^table\
((^no_top_left_border\ |^title\ -AR§cantar |^title\ -ER§comer |^title\ -IR§vivir ))
(( °(yo)° | cant²o² | com²o² | viv²o² ))
(( °(tú)° | cant²as² | com²es² | viv²es² ))
(( °(él,ella,usted)° | cant²a² | com²e² | viv²e² ))
(( °(nosotros,-as)° | cant²amos² | com²emos² | viv²imos² ))
(( °(vosotros,-as)° | cant²áis² | com²éis² | viv²ís² ))
(( °(ellos,-as,uds)° | cant²an² | com²en² | viv²en² ))
]]]
{{^red=²\}}
[[[^width_5_6+border+light_gray_border+padding\
((^width_20\
Batlh biqsip 'ugh chang'eng chuy duran lung dir ghogh habli' jer lor motlh.§
Qan siqwi' tuj muvwi' wogh yor 'o'megh be'etor boqha''egh lodni'pu' jij laq lol lo' law' mevyap.
|
Pivchem qid red rutlh saqjan say'qu'moh siq torgh tlhach mu'mey vilinhod vithay' yem 'iqnah 'irneh.§
Ghitlhwi' jer loghqam me'nal nav habli' notqa' podmoh qaywi' qin qi'tu' red ril siqwi' tagh tahqeq.§
Tiqnagh lemdu' 'och 'orghen rojmab 'urwi' bop chevwi' tlhoy' der mara nuh bey' peghmey vittlhegh.§
Qa'meh quv qep'it qid qin ros saqjan serrum tahqeq tatlh toq van yu'egh 'aqtu' em.
|^width_20\
Naq pach pujwi' qanwi' qutluch qi'lop ron rutlh say'qu'moh tennusnal tlhej.§
Denibya'ngan ghay'cha' janluq dugh hu je lotlhmoq tlhoy' sas valqis ghubdaq hos chohwi' janluq.
))
]]]
[[[^width_100+no_padding\
((
[[[^width_100+padding+small=table\
((^black_fill+dark_gray\ black ))
]]]
|
[[[^table\
((^dark_gray_fill+gray\ dark gray ))
((^dark_orange_fill+orange\ dark orange ))
((^dark_red_fill+red\ dark red ))
((^dark_pink_fill+pink\ dark pink ))
((^dark_violet_fill+violet\ dark violet ))
((^dark_blue_fill+blue\ dark blue ))
((^dark_cyan_fill+cyan\ dark cyan ))
((^dark_green_fill+green\ dark green ))
((^dark_lawn_fill+lawn\ dark lawn ))
((^dark_yellow_fill+yellow\ dark yellow ))
]]]
|
[[[^table\
((^gray_fill+light_gray\ gray ))
((^orange_fill+light_orange\ orange ))
((^red_fill+light_red\ red ))
((^pink_fill+light_pink\ pink ))
((^violet_fill+light_violet\ violet ))
((^blue_fill+light_blue\ blue ))
((^cyan_fill+light_cyan\ cyan ))
((^green_fill+light_green\ green ))
((^lawn_fill+light_lawn\ lawn ))
((^yellow_fill+white\ yellow ))
]]]
|
[[[^table\
((^light_gray_fill+pastel_gray\ light gray ))
((^light_orange_fill+pastel_orange\ light orange ))
((^light_red_fill+pastel_red\ light red ))
((^light_pink_fill+pastel_pink\ light pink ))
((^light_violet_fill+pastel_violet\ light violet ))
((^light_blue_fill+pastel_blue\ light blue ))
((^light_cyan_fill+pastel_cyan\ light cyan ))
((^light_green_fill+pastel_green\ light green ))
((^light_lawn_fill+pastel_lawn\ light lawn ))
((^light_yellow_fill+white\ light yellow ))
]]]
|
[[[^table\
((^pastel_gray_fill+white\ pastel gray ))
((^pastel_orange_fill+white\ pastel orange ))
((^pastel_red_fill+white\ pastel red ))
((^pastel_pink_fill+white\ pastel pink ))
((^pastel_violet_fill+white\ pastel violet ))
((^pastel_blue_fill+white\ pastel blue ))
((^pastel_cyan_fill+white\ pastel cyan ))
((^pastel_green_fill+white\ pastel green ))
((^pastel_lawn_fill+white\ pastel lawn ))
((^pastel_yellow_fill+white\ pastel yellow ))
]]]
|
[[[^table\
((^white_fill+pastel_gray\ white ))
]]]
))
]]]
!! Code
:::
##// ²Colorized source code²##
²if² ³(³ ... ³)³
³{³
...
³}³
²else²
³{³
...
³}³
:::
:::c++\
// Colorized source code
#include <iostream>
using namespace std;
int main()
{
cout << "Hello world!";
return 0;
}
:::
!! List
Four spaces per level.
* List
* List
* Sub-list
* Sub-list
# Numbered sub-list
# Numbered sub-list
# Numbered sub-list
# Numbered sub-list
# Numbered
sub-list
* List
* Sub-list
* Sub-list
* Sub-list
* Sub-list
* Sub-list
* Sub-list
* List§
...
{{{^dash\
* List
* List
* Sub-list
* Sub-list
# Numbered sub-list
# Numbered sub-list
# Numbered sub-list
# Numbered sub-list
# Numbered
sub-list
* List
* Sub-list
* Sub-list
* Sub-list
* Sub-list
* Sub-list
* Sub-list
* List§
...
}}}
!! Link
@@http://www.github.com This is a link@@
@@http://www.github.com [[image.jpg:20]]@@
@@http://www.github.com@@
!! Image
Small :
[[image.jpg:20]][[image_2.jpg:20]]§
[[image_3.jpg:20]][[image_4.jpg:20]][[image_5.jpg:20]]
Medium :
[[image_3.jpg:40]][[image_4.jpg:40]]
Large :
[[image.jpg]]§
[[image_2.jpg:]]§
[[image_4.jpg:,100]]
Custom :
[[image_5.jpg:50vw,50%]]
!! HTML
²Pendown tags² can be mixed with <span style="color:green">HTML tags</span>.
</xmp>
<script src="../pendown.js"></script>Open the "sample.html" file with a web-browser like Firefox.
If the Comic Sans and Consolas fonts are installed on your system, you should see the following result :
The source code programming language can be specified with the following keywords :
- C : c h
- C++ : c++ h++ cpp hpp cxx hxx
- C# : c# cs
- D : d
- Java : java
- JavaScript : js
- TypeScript : ts
When colorizing a source code file, its programming language is deduced from the file extension if it matches one of the above keywords.
Just put the "pendown.css" and "pendown.js" files in the same folder as your HTML files, or in a folder accessible from them.
Write your Pendown text inside the <xmp> section.
<meta charset="utf8"/>
<link rel="stylesheet" href="pendown.css">
<xmp>
$$Hello world !$$
</xmp>
<script src="pendown.js"></script>The Pendown page doesn't show the converted text.
Check that the Pendown file extension is ".html".
Check that your text is between the <xmp> and </xmp> tags.
Check that the relative paths to "pendown.css" and "pendown.js" are correct.
The Pendown page doesn't use the Comic Sans MS or Consolas font as in the "sample.png" image.
Check that both fonts are properly installed on your system.
The Pendown page doens't show the page breaks in the browser.
This is normal, page breaks are only applied when the web page is printed from the browser, or when the generated HTML file is loaded in LibreOffice Writer.
How can I force Pendown to use black as the default text color ?
Replace <xmp> by <xmp class="black"> in the HTML file.
How can I hide the Pendown text until it has been converted into HTML ?
Replace <xmp> by <xmp style="display:none"> in the HTML file.
Install the DMD 2 compiler.
Build the executable with the following command line :
dmd -m64 pendown.dpendown [options] input_file output_file--colorize : generate a Pendown file from a source code file
--process : generate a HTML file from a Pendown file
--loadable : make the HTML file loadable in LibreOffice Writer
--script : make the HTML file import the Pendown script file
--style : make the HTML file import the Pendown style file
--language c|c++|cpp|c#|cs|d|java|js|ts : set the source code language
--tabulation 4 : set the text tabulation space count
--indentation 4 : set the list indentation space count
--page 21 29.7 2 1 1 1 : resize the images for a LibreOffice Writer document of this page width, height, left margin, right margin, top margin and bottom margin
--path PENDOWN_FOLDER/ : set the path of the imported Pendown files
pendown --process --style --path ../ document.pd document.htmlConverts a Pendown file to a HTML file which imports the Pendown style file.
pendown --process --page 18 27.7 --style --path ../ document.pd document.htmlConverts a Pendown file to a HTML file which can be imported in LibreOffice Writer
pendown --script --style --path ../ document.pd document.htmlConverts a Pendown file to a HTML file which imports the Pendown script and style files to convert the Pendown tags inside the web browser.
pendown --colorize code.d code.pdConverts a D source code file to a Pendown file.
pendown --colorize --process --style --path ../ code.d code.htmlConverts a D source code file to a HTML file which imports the Pendown style file.
pendown --colorize --script --style --path ../ code.d code.htmlConverts a D source code file to a HTML file which imports the Pendown script and style files to convert the Pendown tags inside the web browser.
- Lists are not processed inside preformatted blocks.
- The Pendown text can't contain
<xmp>tags if it is converted to HTML by the web browser script.
2.1
Eric Pelzer ([email protected]).
This project is licensed under the GNU General Public License version 3.
See the LICENSE.md file for details.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent