summaryrefslogtreecommitdiff
path: root/website/README-website.txt
blob: cb034f3518dda27e4498b771016b8b499ac57baa (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
AsciiDoc Website
================

The AsciiDoc website source is included in the AsciiDoc distribution
as an example of using AsciiDoc to build a website. The files are
principally located under `/doc` and `/website`, with a handful of
files pulled in from the root directory.

A simple shell script (`./build_website.sh`) will
build the site's web pages -- just set the `LAYOUT` variable to the
desired layout.

Website Layouts
---------------
The website layout is determined by the layout configuration file
(`layout1.conf` or `layout2.conf`) and corresponding layout CSS file
(`layout1.css` or `layout2.css`). The example website comes with the
following layouts:

[width="80%",cols="1,4",options="header"]
|====================================================================
|Layout   |  Description
|layout1  |  Table based layout
|layout2  |  CSS based layout (this is the default layout)
|====================================================================

The default tables based layout (layout1) works with most modern
browsers.

NOTE: The simulated frames layout (layout2) does not work with IE6.