summaryrefslogtreecommitdiff
path: root/README.html
blob: 899d949b71426dc77c5890caa87af9df3e470626 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
    "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<meta name="generator" content="AsciiDoc 10.0.0a2" />
<title></title>
<link rel="stylesheet" href="./asciidoc.css" type="text/css" />
<link rel="stylesheet" href="./layout2.css" type="text/css" />
<script type="text/javascript" src="./asciidoc.js"></script>
<script type="text/javascript">
/*<![CDATA[*/
asciidoc.install();
/*]]>*/
</script>
</head>
<body style="max-width:70em">
<div id="layout-menu-box">
<div id="layout-menu">
  <div>&#187;<a href="index.html">Home</a></div>
  <div>&#187;<a href="userguide.html">User&nbsp;Guide</a></div>
  <div>&#187;<a href="INSTALL.html">Installation</a></div>
  <div>&#187;<a href="faq.html">FAQ</a></div>
  <div>&#187;<a href="manpage.html">asciidoc(1)</a></div>
  <div>&#187;<a href="a2x.1.html">a2x(1)</a></div>
  <div>&#187;<a href="asciidocapi.html">API</a></div>
  <div>&#187;<a href="plugins.html">Plugins</a></div>
  <div>&#187;<a href="http://powerman.name/doc/asciidoc">Cheatsheet</a></div>
  <div>&#187;<a href="testasciidoc.html">Tests</a></div>
  <div>&#187;<a href="CHANGELOG.html">ChangeLog</a></div>
  <div>&#187;<a href="support.html">Support</a></div>
  <div id="page-source">&#187;<a href="README.txt">Page&nbsp;Source</a></div>
</div>
</div>
<div id="layout-content-box">
<div id="layout-banner">
  <div id="layout-title">AsciiDoc</div>
  <div id="layout-description">Text based document generation</div>
</div>
<div id="layout-content">
<div id="header">
</div>
<div id="content">
<h1 id="_asciidoc" class="float">AsciiDoc</h1>
<div class="paragraph"><p><span class="image">
<a class="image" href="https://github.com/asciidoc/asciidoc-py3/actions?query=workflow%3ATest+branch%3Amaster">
<img src="https://github.com/asciidoc/asciidoc-py3/workflows/Test/badge.svg?branch=master" alt="Build Status" />
</a>
</span></p></div>
<div class="paragraph"><p>AsciiDoc is a text document format for writing notes, documentation,
articles, books, ebooks, slideshows, web pages, man pages and blogs.
AsciiDoc files can be translated to many formats including HTML, PDF,
EPUB, man page.</p></div>
<div class="paragraph"><p>AsciiDoc is highly configurable: both the AsciiDoc source file syntax
and the backend output markups (which can be almost any type of
SGML/XML markup) can be customized and extended by the user.</p></div>
<div class="sect1">
<h2 id="_prerequisites">Prerequisites</h2>
<div class="sectionbody">
<div class="paragraph"><p>AsciiDoc is written in Python so you need a Python interpreter
(version 3.5 or later) to execute <code>asciidoc(1)</code>. Python is installed by
default in most Linux distributions.  You can download Python from the
official Python website <a href="http://www.python.org">http://www.python.org</a>.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_obtaining_asciidoc">Obtaining AsciiDoc</h2>
<div class="sectionbody">
<div class="paragraph"><p>AsciiDoc&#8217;s Python 3 port is currently under development. To obtain AsciiDoc,
download a copy of the repo from the GitHub project at
<a href="https://github.com/asciidoc/asciidoc-py3">https://github.com/asciidoc/asciidoc-py3</a> and follow the instructions in
INSTALL.txt to build and install it.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_tools">Tools</h2>
<div class="sectionbody">
<div class="paragraph"><p>Current AsciiDoc version tested on Ubuntu 18.04 with:</p></div>
<div class="ulist"><ul>
<li>
<p>
Python 3.6.5
</p>
</li>
<li>
<p>
DocBook XSL Stylesheets 1.76.1
</p>
</li>
<li>
<p>
xsltproc (libxml 20706, libxslt 10126 and libexslt 815).
</p>
</li>
<li>
<p>
w3m 0.5.2
</p>
</li>
<li>
<p>
dblatex 0.3
</p>
</li>
<li>
<p>
FOP 0.95
</p>
</li>
<li>
<p>
A-A-P 1.091
</p>
</li>
</ul></div>
</div>
</div>
<div class="sect1">
<h2 id="_copying">Copying</h2>
<div class="sectionbody">
<div class="paragraph"><p>Copyright &#169; 2002-2013 Stuart Rackham.</p></div>
<div class="paragraph"><p>Copyright &#169; 2013-2020 AsciiDoc Contributors.</p></div>
<div class="paragraph"><p>Free use of this software is granted under the terms of the GNU General
Public License version 2 (GPLv2).</p></div>
<div class="paragraph"><p>AsciiDoc is a trademark of the Eclipse Foundation, Inc.</p></div>
</div>
</div>
</div>
<div id="footnotes"><hr /></div>
<div id="footer">
<div id="footer-text">
Version 9.0.5<br />
Last updated 2021-02-06 02:01:36 UTC<br />
AsciiDoc is a trademark of the Eclipse Foundation, Inc.
</div>
<div id="footer-badges">
<a href="https://validator.w3.org/check?uri=referer">
  <img style="border:0;width:88px;height:31px"
    src="https://www.w3.org/Icons/valid-xhtml11-blue"
    alt="Valid XHTML 1.1" height="31" width="88" />
</a>
<a href="https://jigsaw.w3.org/css-validator/">
  <img style="border:0;width:88px;height:31px"
    src="https://jigsaw.w3.org/css-validator/images/vcss-blue"
    alt="Valid CSS!" />
</a>
</div>
</div>
</div>
</div>
</body>
</html>