-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[DOCS] PDF output improvements; added preliminary wire documentation
This commit makes several changes designed to improve the PDF version of the documentation when it is built by @readthedocs, including: - Unsplit /docs/index.rst and /docs/general/home.rst (reversed commit cfc5145) - Moved `toctree` directives in /docs/index.rst to relevant sections in the page; adjusted the wording of these sections This commit also adds a basic description of Aluminum Wire to the documentation, and it includes some information about the /prefs directory.
- Loading branch information
Showing
3 changed files
with
41 additions
and
32 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
************* | ||
Aluminum Wire | ||
************* | ||
|
||
Aluminum Wire is a highly-customizable and extensible static file server that also includes support for dynamic files (using both Node.js and PHP). |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,17 +1,48 @@ | ||
.. include:: ./general/home.rst | ||
************************************** | ||
Welcome to the Aluminum Documentation. | ||
************************************** | ||
|
||
What is Aluminum? | ||
================= | ||
|
||
Aluminum is a lightweight, simple-to-install, and easy-to-use web server written entirely in `Node.js <https://www.nodejs.org>`_, "an asynchronous event-driven JavaScript runtime ... designed to build scalable network applications." It includes not only a traditional static/dynamic web server, but also various other features that simplify the web development process, such as authentication and network-based cryptography platforms. | ||
|
||
Features | ||
======== | ||
|
||
Aluminum offers several unique and useful features: | ||
|
||
* **Highly Customizable:** Use an official extension, a community-contributed one, or make your own. | ||
* **Integrated Authentication Server:** Verify end users' identity without leaving the Aluminum platform. | ||
* **PHP support:** If you're uncomfortable using Node.js for server-side scripting, Aluminum is also compatible with PHP. | ||
* **And more:** Remote system resource monitor, network based time synchronization, math rendering, simplified cryptography, etc. | ||
|
||
|
||
.. toctree:: | ||
:maxdepth: 2 | ||
:caption: General Documentation | ||
:caption: Documentation by Feature | ||
:numbered: | ||
:hidden: | ||
|
||
Welcome Page <general/home> | ||
general/ports | ||
features/wire | ||
|
||
|
||
Setup and General Knowledge | ||
=========================== | ||
|
||
.. note:: In this documentation, ``/`` refers to the root directory of the Aluminum repository, except as otherwise noted. | ||
|
||
To install Aluminum, simply clone the git repository, install the dependencies automatically with ``yarn``, and copy the default configuration files into the ``/prefs`` directory. Starting the web server is as simple as typing ``yarn run start`` into your terminal. | ||
|
||
.. seealso:: If you want to install Aluminum, please see the installation guide for more detailed instructions. | ||
|
||
Aluminum is controlled by configuration files written in JSON. These files are included in the ``/prefs`` directory. | ||
|
||
|
||
.. toctree:: | ||
:maxdepth: 2 | ||
:caption: Documentation by Feature | ||
:caption: General Documentation | ||
:numbered: | ||
:hidden: | ||
|
||
general/ports |