switched to tape and string
This commit is contained in:
parent
95f929d6a4
commit
1cec64fb9e
3
.gitignore
vendored
3
.gitignore
vendored
@ -1 +1,2 @@
|
||||
public
|
||||
out
|
||||
|
||||
|
3
.gitmodules
vendored
3
.gitmodules
vendored
@ -1,3 +0,0 @@
|
||||
[submodule "themes/book"]
|
||||
path = themes/book
|
||||
url = https://github.com/getzola/book.git
|
5
Gemfile
Normal file
5
Gemfile
Normal file
@ -0,0 +1,5 @@
|
||||
# frozen_string_literal: true
|
||||
source "https://rubygems.org"
|
||||
|
||||
gem "org-ruby", "~> 0.9.12"
|
||||
gem "RedCloth", "~> 4.3"
|
17
Gemfile.lock
Normal file
17
Gemfile.lock
Normal file
@ -0,0 +1,17 @@
|
||||
GEM
|
||||
remote: https://rubygems.org/
|
||||
specs:
|
||||
RedCloth (4.3.2)
|
||||
org-ruby (0.9.12)
|
||||
rubypants (~> 0.2)
|
||||
rubypants (0.7.1)
|
||||
|
||||
PLATFORMS
|
||||
x86_64-linux
|
||||
|
||||
DEPENDENCIES
|
||||
RedCloth (~> 4.3)
|
||||
org-ruby (~> 0.9.12)
|
||||
|
||||
BUNDLED WITH
|
||||
2.4.1
|
451
LICENSE.txt
451
LICENSE.txt
@ -1,451 +0,0 @@
|
||||
|
||||
GNU Free Documentation License
|
||||
Version 1.3, 3 November 2008
|
||||
|
||||
|
||||
Copyright (C) 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc.
|
||||
<https://fsf.org/>
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
0. PREAMBLE
|
||||
|
||||
The purpose of this License is to make a manual, textbook, or other
|
||||
functional and useful document "free" in the sense of freedom: to
|
||||
assure everyone the effective freedom to copy and redistribute it,
|
||||
with or without modifying it, either commercially or noncommercially.
|
||||
Secondarily, this License preserves for the author and publisher a way
|
||||
to get credit for their work, while not being considered responsible
|
||||
for modifications made by others.
|
||||
|
||||
This License is a kind of "copyleft", which means that derivative
|
||||
works of the document must themselves be free in the same sense. It
|
||||
complements the GNU General Public License, which is a copyleft
|
||||
license designed for free software.
|
||||
|
||||
We have designed this License in order to use it for manuals for free
|
||||
software, because free software needs free documentation: a free
|
||||
program should come with manuals providing the same freedoms that the
|
||||
software does. But this License is not limited to software manuals;
|
||||
it can be used for any textual work, regardless of subject matter or
|
||||
whether it is published as a printed book. We recommend this License
|
||||
principally for works whose purpose is instruction or reference.
|
||||
|
||||
|
||||
1. APPLICABILITY AND DEFINITIONS
|
||||
|
||||
This License applies to any manual or other work, in any medium, that
|
||||
contains a notice placed by the copyright holder saying it can be
|
||||
distributed under the terms of this License. Such a notice grants a
|
||||
world-wide, royalty-free license, unlimited in duration, to use that
|
||||
work under the conditions stated herein. The "Document", below,
|
||||
refers to any such manual or work. Any member of the public is a
|
||||
licensee, and is addressed as "you". You accept the license if you
|
||||
copy, modify or distribute the work in a way requiring permission
|
||||
under copyright law.
|
||||
|
||||
A "Modified Version" of the Document means any work containing the
|
||||
Document or a portion of it, either copied verbatim, or with
|
||||
modifications and/or translated into another language.
|
||||
|
||||
A "Secondary Section" is a named appendix or a front-matter section of
|
||||
the Document that deals exclusively with the relationship of the
|
||||
publishers or authors of the Document to the Document's overall
|
||||
subject (or to related matters) and contains nothing that could fall
|
||||
directly within that overall subject. (Thus, if the Document is in
|
||||
part a textbook of mathematics, a Secondary Section may not explain
|
||||
any mathematics.) The relationship could be a matter of historical
|
||||
connection with the subject or with related matters, or of legal,
|
||||
commercial, philosophical, ethical or political position regarding
|
||||
them.
|
||||
|
||||
The "Invariant Sections" are certain Secondary Sections whose titles
|
||||
are designated, as being those of Invariant Sections, in the notice
|
||||
that says that the Document is released under this License. If a
|
||||
section does not fit the above definition of Secondary then it is not
|
||||
allowed to be designated as Invariant. The Document may contain zero
|
||||
Invariant Sections. If the Document does not identify any Invariant
|
||||
Sections then there are none.
|
||||
|
||||
The "Cover Texts" are certain short passages of text that are listed,
|
||||
as Front-Cover Texts or Back-Cover Texts, in the notice that says that
|
||||
the Document is released under this License. A Front-Cover Text may
|
||||
be at most 5 words, and a Back-Cover Text may be at most 25 words.
|
||||
|
||||
A "Transparent" copy of the Document means a machine-readable copy,
|
||||
represented in a format whose specification is available to the
|
||||
general public, that is suitable for revising the document
|
||||
straightforwardly with generic text editors or (for images composed of
|
||||
pixels) generic paint programs or (for drawings) some widely available
|
||||
drawing editor, and that is suitable for input to text formatters or
|
||||
for automatic translation to a variety of formats suitable for input
|
||||
to text formatters. A copy made in an otherwise Transparent file
|
||||
format whose markup, or absence of markup, has been arranged to thwart
|
||||
or discourage subsequent modification by readers is not Transparent.
|
||||
An image format is not Transparent if used for any substantial amount
|
||||
of text. A copy that is not "Transparent" is called "Opaque".
|
||||
|
||||
Examples of suitable formats for Transparent copies include plain
|
||||
ASCII without markup, Texinfo input format, LaTeX input format, SGML
|
||||
or XML using a publicly available DTD, and standard-conforming simple
|
||||
HTML, PostScript or PDF designed for human modification. Examples of
|
||||
transparent image formats include PNG, XCF and JPG. Opaque formats
|
||||
include proprietary formats that can be read and edited only by
|
||||
proprietary word processors, SGML or XML for which the DTD and/or
|
||||
processing tools are not generally available, and the
|
||||
machine-generated HTML, PostScript or PDF produced by some word
|
||||
processors for output purposes only.
|
||||
|
||||
The "Title Page" means, for a printed book, the title page itself,
|
||||
plus such following pages as are needed to hold, legibly, the material
|
||||
this License requires to appear in the title page. For works in
|
||||
formats which do not have any title page as such, "Title Page" means
|
||||
the text near the most prominent appearance of the work's title,
|
||||
preceding the beginning of the body of the text.
|
||||
|
||||
The "publisher" means any person or entity that distributes copies of
|
||||
the Document to the public.
|
||||
|
||||
A section "Entitled XYZ" means a named subunit of the Document whose
|
||||
title either is precisely XYZ or contains XYZ in parentheses following
|
||||
text that translates XYZ in another language. (Here XYZ stands for a
|
||||
specific section name mentioned below, such as "Acknowledgements",
|
||||
"Dedications", "Endorsements", or "History".) To "Preserve the Title"
|
||||
of such a section when you modify the Document means that it remains a
|
||||
section "Entitled XYZ" according to this definition.
|
||||
|
||||
The Document may include Warranty Disclaimers next to the notice which
|
||||
states that this License applies to the Document. These Warranty
|
||||
Disclaimers are considered to be included by reference in this
|
||||
License, but only as regards disclaiming warranties: any other
|
||||
implication that these Warranty Disclaimers may have is void and has
|
||||
no effect on the meaning of this License.
|
||||
|
||||
2. VERBATIM COPYING
|
||||
|
||||
You may copy and distribute the Document in any medium, either
|
||||
commercially or noncommercially, provided that this License, the
|
||||
copyright notices, and the license notice saying this License applies
|
||||
to the Document are reproduced in all copies, and that you add no
|
||||
other conditions whatsoever to those of this License. You may not use
|
||||
technical measures to obstruct or control the reading or further
|
||||
copying of the copies you make or distribute. However, you may accept
|
||||
compensation in exchange for copies. If you distribute a large enough
|
||||
number of copies you must also follow the conditions in section 3.
|
||||
|
||||
You may also lend copies, under the same conditions stated above, and
|
||||
you may publicly display copies.
|
||||
|
||||
|
||||
3. COPYING IN QUANTITY
|
||||
|
||||
If you publish printed copies (or copies in media that commonly have
|
||||
printed covers) of the Document, numbering more than 100, and the
|
||||
Document's license notice requires Cover Texts, you must enclose the
|
||||
copies in covers that carry, clearly and legibly, all these Cover
|
||||
Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on
|
||||
the back cover. Both covers must also clearly and legibly identify
|
||||
you as the publisher of these copies. The front cover must present
|
||||
the full title with all words of the title equally prominent and
|
||||
visible. You may add other material on the covers in addition.
|
||||
Copying with changes limited to the covers, as long as they preserve
|
||||
the title of the Document and satisfy these conditions, can be treated
|
||||
as verbatim copying in other respects.
|
||||
|
||||
If the required texts for either cover are too voluminous to fit
|
||||
legibly, you should put the first ones listed (as many as fit
|
||||
reasonably) on the actual cover, and continue the rest onto adjacent
|
||||
pages.
|
||||
|
||||
If you publish or distribute Opaque copies of the Document numbering
|
||||
more than 100, you must either include a machine-readable Transparent
|
||||
copy along with each Opaque copy, or state in or with each Opaque copy
|
||||
a computer-network location from which the general network-using
|
||||
public has access to download using public-standard network protocols
|
||||
a complete Transparent copy of the Document, free of added material.
|
||||
If you use the latter option, you must take reasonably prudent steps,
|
||||
when you begin distribution of Opaque copies in quantity, to ensure
|
||||
that this Transparent copy will remain thus accessible at the stated
|
||||
location until at least one year after the last time you distribute an
|
||||
Opaque copy (directly or through your agents or retailers) of that
|
||||
edition to the public.
|
||||
|
||||
It is requested, but not required, that you contact the authors of the
|
||||
Document well before redistributing any large number of copies, to
|
||||
give them a chance to provide you with an updated version of the
|
||||
Document.
|
||||
|
||||
|
||||
4. MODIFICATIONS
|
||||
|
||||
You may copy and distribute a Modified Version of the Document under
|
||||
the conditions of sections 2 and 3 above, provided that you release
|
||||
the Modified Version under precisely this License, with the Modified
|
||||
Version filling the role of the Document, thus licensing distribution
|
||||
and modification of the Modified Version to whoever possesses a copy
|
||||
of it. In addition, you must do these things in the Modified Version:
|
||||
|
||||
A. Use in the Title Page (and on the covers, if any) a title distinct
|
||||
from that of the Document, and from those of previous versions
|
||||
(which should, if there were any, be listed in the History section
|
||||
of the Document). You may use the same title as a previous version
|
||||
if the original publisher of that version gives permission.
|
||||
B. List on the Title Page, as authors, one or more persons or entities
|
||||
responsible for authorship of the modifications in the Modified
|
||||
Version, together with at least five of the principal authors of the
|
||||
Document (all of its principal authors, if it has fewer than five),
|
||||
unless they release you from this requirement.
|
||||
C. State on the Title page the name of the publisher of the
|
||||
Modified Version, as the publisher.
|
||||
D. Preserve all the copyright notices of the Document.
|
||||
E. Add an appropriate copyright notice for your modifications
|
||||
adjacent to the other copyright notices.
|
||||
F. Include, immediately after the copyright notices, a license notice
|
||||
giving the public permission to use the Modified Version under the
|
||||
terms of this License, in the form shown in the Addendum below.
|
||||
G. Preserve in that license notice the full lists of Invariant Sections
|
||||
and required Cover Texts given in the Document's license notice.
|
||||
H. Include an unaltered copy of this License.
|
||||
I. Preserve the section Entitled "History", Preserve its Title, and add
|
||||
to it an item stating at least the title, year, new authors, and
|
||||
publisher of the Modified Version as given on the Title Page. If
|
||||
there is no section Entitled "History" in the Document, create one
|
||||
stating the title, year, authors, and publisher of the Document as
|
||||
given on its Title Page, then add an item describing the Modified
|
||||
Version as stated in the previous sentence.
|
||||
J. Preserve the network location, if any, given in the Document for
|
||||
public access to a Transparent copy of the Document, and likewise
|
||||
the network locations given in the Document for previous versions
|
||||
it was based on. These may be placed in the "History" section.
|
||||
You may omit a network location for a work that was published at
|
||||
least four years before the Document itself, or if the original
|
||||
publisher of the version it refers to gives permission.
|
||||
K. For any section Entitled "Acknowledgements" or "Dedications",
|
||||
Preserve the Title of the section, and preserve in the section all
|
||||
the substance and tone of each of the contributor acknowledgements
|
||||
and/or dedications given therein.
|
||||
L. Preserve all the Invariant Sections of the Document,
|
||||
unaltered in their text and in their titles. Section numbers
|
||||
or the equivalent are not considered part of the section titles.
|
||||
M. Delete any section Entitled "Endorsements". Such a section
|
||||
may not be included in the Modified Version.
|
||||
N. Do not retitle any existing section to be Entitled "Endorsements"
|
||||
or to conflict in title with any Invariant Section.
|
||||
O. Preserve any Warranty Disclaimers.
|
||||
|
||||
If the Modified Version includes new front-matter sections or
|
||||
appendices that qualify as Secondary Sections and contain no material
|
||||
copied from the Document, you may at your option designate some or all
|
||||
of these sections as invariant. To do this, add their titles to the
|
||||
list of Invariant Sections in the Modified Version's license notice.
|
||||
These titles must be distinct from any other section titles.
|
||||
|
||||
You may add a section Entitled "Endorsements", provided it contains
|
||||
nothing but endorsements of your Modified Version by various
|
||||
parties--for example, statements of peer review or that the text has
|
||||
been approved by an organization as the authoritative definition of a
|
||||
standard.
|
||||
|
||||
You may add a passage of up to five words as a Front-Cover Text, and a
|
||||
passage of up to 25 words as a Back-Cover Text, to the end of the list
|
||||
of Cover Texts in the Modified Version. Only one passage of
|
||||
Front-Cover Text and one of Back-Cover Text may be added by (or
|
||||
through arrangements made by) any one entity. If the Document already
|
||||
includes a cover text for the same cover, previously added by you or
|
||||
by arrangement made by the same entity you are acting on behalf of,
|
||||
you may not add another; but you may replace the old one, on explicit
|
||||
permission from the previous publisher that added the old one.
|
||||
|
||||
The author(s) and publisher(s) of the Document do not by this License
|
||||
give permission to use their names for publicity for or to assert or
|
||||
imply endorsement of any Modified Version.
|
||||
|
||||
|
||||
5. COMBINING DOCUMENTS
|
||||
|
||||
You may combine the Document with other documents released under this
|
||||
License, under the terms defined in section 4 above for modified
|
||||
versions, provided that you include in the combination all of the
|
||||
Invariant Sections of all of the original documents, unmodified, and
|
||||
list them all as Invariant Sections of your combined work in its
|
||||
license notice, and that you preserve all their Warranty Disclaimers.
|
||||
|
||||
The combined work need only contain one copy of this License, and
|
||||
multiple identical Invariant Sections may be replaced with a single
|
||||
copy. If there are multiple Invariant Sections with the same name but
|
||||
different contents, make the title of each such section unique by
|
||||
adding at the end of it, in parentheses, the name of the original
|
||||
author or publisher of that section if known, or else a unique number.
|
||||
Make the same adjustment to the section titles in the list of
|
||||
Invariant Sections in the license notice of the combined work.
|
||||
|
||||
In the combination, you must combine any sections Entitled "History"
|
||||
in the various original documents, forming one section Entitled
|
||||
"History"; likewise combine any sections Entitled "Acknowledgements",
|
||||
and any sections Entitled "Dedications". You must delete all sections
|
||||
Entitled "Endorsements".
|
||||
|
||||
|
||||
6. COLLECTIONS OF DOCUMENTS
|
||||
|
||||
You may make a collection consisting of the Document and other
|
||||
documents released under this License, and replace the individual
|
||||
copies of this License in the various documents with a single copy
|
||||
that is included in the collection, provided that you follow the rules
|
||||
of this License for verbatim copying of each of the documents in all
|
||||
other respects.
|
||||
|
||||
You may extract a single document from such a collection, and
|
||||
distribute it individually under this License, provided you insert a
|
||||
copy of this License into the extracted document, and follow this
|
||||
License in all other respects regarding verbatim copying of that
|
||||
document.
|
||||
|
||||
|
||||
7. AGGREGATION WITH INDEPENDENT WORKS
|
||||
|
||||
A compilation of the Document or its derivatives with other separate
|
||||
and independent documents or works, in or on a volume of a storage or
|
||||
distribution medium, is called an "aggregate" if the copyright
|
||||
resulting from the compilation is not used to limit the legal rights
|
||||
of the compilation's users beyond what the individual works permit.
|
||||
When the Document is included in an aggregate, this License does not
|
||||
apply to the other works in the aggregate which are not themselves
|
||||
derivative works of the Document.
|
||||
|
||||
If the Cover Text requirement of section 3 is applicable to these
|
||||
copies of the Document, then if the Document is less than one half of
|
||||
the entire aggregate, the Document's Cover Texts may be placed on
|
||||
covers that bracket the Document within the aggregate, or the
|
||||
electronic equivalent of covers if the Document is in electronic form.
|
||||
Otherwise they must appear on printed covers that bracket the whole
|
||||
aggregate.
|
||||
|
||||
|
||||
8. TRANSLATION
|
||||
|
||||
Translation is considered a kind of modification, so you may
|
||||
distribute translations of the Document under the terms of section 4.
|
||||
Replacing Invariant Sections with translations requires special
|
||||
permission from their copyright holders, but you may include
|
||||
translations of some or all Invariant Sections in addition to the
|
||||
original versions of these Invariant Sections. You may include a
|
||||
translation of this License, and all the license notices in the
|
||||
Document, and any Warranty Disclaimers, provided that you also include
|
||||
the original English version of this License and the original versions
|
||||
of those notices and disclaimers. In case of a disagreement between
|
||||
the translation and the original version of this License or a notice
|
||||
or disclaimer, the original version will prevail.
|
||||
|
||||
If a section in the Document is Entitled "Acknowledgements",
|
||||
"Dedications", or "History", the requirement (section 4) to Preserve
|
||||
its Title (section 1) will typically require changing the actual
|
||||
title.
|
||||
|
||||
|
||||
9. TERMINATION
|
||||
|
||||
You may not copy, modify, sublicense, or distribute the Document
|
||||
except as expressly provided under this License. Any attempt
|
||||
otherwise to copy, modify, sublicense, or distribute it is void, and
|
||||
will automatically terminate your rights under this License.
|
||||
|
||||
However, if you cease all violation of this License, then your license
|
||||
from a particular copyright holder is reinstated (a) provisionally,
|
||||
unless and until the copyright holder explicitly and finally
|
||||
terminates your license, and (b) permanently, if the copyright holder
|
||||
fails to notify you of the violation by some reasonable means prior to
|
||||
60 days after the cessation.
|
||||
|
||||
Moreover, your license from a particular copyright holder is
|
||||
reinstated permanently if the copyright holder notifies you of the
|
||||
violation by some reasonable means, this is the first time you have
|
||||
received notice of violation of this License (for any work) from that
|
||||
copyright holder, and you cure the violation prior to 30 days after
|
||||
your receipt of the notice.
|
||||
|
||||
Termination of your rights under this section does not terminate the
|
||||
licenses of parties who have received copies or rights from you under
|
||||
this License. If your rights have been terminated and not permanently
|
||||
reinstated, receipt of a copy of some or all of the same material does
|
||||
not give you any rights to use it.
|
||||
|
||||
|
||||
10. FUTURE REVISIONS OF THIS LICENSE
|
||||
|
||||
The Free Software Foundation may publish new, revised versions of the
|
||||
GNU Free Documentation License from time to time. Such new versions
|
||||
will be similar in spirit to the present version, but may differ in
|
||||
detail to address new problems or concerns. See
|
||||
https://www.gnu.org/licenses/.
|
||||
|
||||
Each version of the License is given a distinguishing version number.
|
||||
If the Document specifies that a particular numbered version of this
|
||||
License "or any later version" applies to it, you have the option of
|
||||
following the terms and conditions either of that specified version or
|
||||
of any later version that has been published (not as a draft) by the
|
||||
Free Software Foundation. If the Document does not specify a version
|
||||
number of this License, you may choose any version ever published (not
|
||||
as a draft) by the Free Software Foundation. If the Document
|
||||
specifies that a proxy can decide which future versions of this
|
||||
License can be used, that proxy's public statement of acceptance of a
|
||||
version permanently authorizes you to choose that version for the
|
||||
Document.
|
||||
|
||||
11. RELICENSING
|
||||
|
||||
"Massive Multiauthor Collaboration Site" (or "MMC Site") means any
|
||||
World Wide Web server that publishes copyrightable works and also
|
||||
provides prominent facilities for anybody to edit those works. A
|
||||
public wiki that anybody can edit is an example of such a server. A
|
||||
"Massive Multiauthor Collaboration" (or "MMC") contained in the site
|
||||
means any set of copyrightable works thus published on the MMC site.
|
||||
|
||||
"CC-BY-SA" means the Creative Commons Attribution-Share Alike 3.0
|
||||
license published by Creative Commons Corporation, a not-for-profit
|
||||
corporation with a principal place of business in San Francisco,
|
||||
California, as well as future copyleft versions of that license
|
||||
published by that same organization.
|
||||
|
||||
"Incorporate" means to publish or republish a Document, in whole or in
|
||||
part, as part of another Document.
|
||||
|
||||
An MMC is "eligible for relicensing" if it is licensed under this
|
||||
License, and if all works that were first published under this License
|
||||
somewhere other than this MMC, and subsequently incorporated in whole or
|
||||
in part into the MMC, (1) had no cover texts or invariant sections, and
|
||||
(2) were thus incorporated prior to November 1, 2008.
|
||||
|
||||
The operator of an MMC Site may republish an MMC contained in the site
|
||||
under CC-BY-SA on the same site at any time before August 1, 2009,
|
||||
provided the MMC is eligible for relicensing.
|
||||
|
||||
|
||||
ADDENDUM: How to use this License for your documents
|
||||
|
||||
To use this License in a document you have written, include a copy of
|
||||
the License in the document and put the following copyright and
|
||||
license notices just after the title page:
|
||||
|
||||
Copyright (c) YEAR YOUR NAME.
|
||||
Permission is granted to copy, distribute and/or modify this document
|
||||
under the terms of the GNU Free Documentation License, Version 1.3
|
||||
or any later version published by the Free Software Foundation;
|
||||
with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
|
||||
A copy of the license is included in the section entitled "GNU
|
||||
Free Documentation License".
|
||||
|
||||
If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts,
|
||||
replace the "with...Texts." line with this:
|
||||
|
||||
with the Invariant Sections being LIST THEIR TITLES, with the
|
||||
Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST.
|
||||
|
||||
If you have Invariant Sections without Cover Texts, or some other
|
||||
combination of the three, merge those two alternatives to suit the
|
||||
situation.
|
||||
|
||||
If your document contains nontrivial examples of program code, we
|
||||
recommend releasing these examples in parallel under your choice of
|
||||
free software license, such as the GNU General Public License,
|
||||
to permit their use in free software.
|
23
Makefile
Normal file
23
Makefile
Normal file
@ -0,0 +1,23 @@
|
||||
.PHONY: all list-doc list-sass list-rest list-dir list clean push
|
||||
list: list-doc list-sass list-rest list-dir
|
||||
list-doc:
|
||||
@echo "====DOCUMENT FILES===="
|
||||
find . -wholename './.hg' -prune , -type f -name '*.txti' , -name '*.org' , -name '*.md'
|
||||
list-sass:
|
||||
@echo "======SASS FILES======"
|
||||
find . -wholename './.hg' -prune , -type f -name '*.s[ca]ss'
|
||||
list-rest:
|
||||
@echo "======OTHER FILES====="
|
||||
find . -wholename './.hg' -prune , -type f -and ! \( -name '*.org' , -name '*.txti' , -name '*.md' , -name .hg \)
|
||||
list-dir:
|
||||
@echo "=====DIRECTORIES======"
|
||||
find . -wholename './.hg' -prune , -type d -not -name .hg
|
||||
clean:
|
||||
rm -rf out
|
||||
build:
|
||||
./render.sh
|
||||
./gensimap.sh
|
||||
out: build
|
||||
@echo -e "\e[38;5;217m*mwah!*~\e[0m"
|
||||
push: build
|
||||
rclone sync -v out/ neo:/
|
25
README.md
Normal file
25
README.md
Normal file
@ -0,0 +1,25 @@
|
||||
# Atlas48's Neocites Archives
|
||||
Welcome to the technical documentation for my [Neocities](https://neocities.org) page, which also contains a rudimentary static site generator cobbled together out of unix tools
|
||||
and Ruby scripts
|
||||
|
||||
# License
|
||||
All markup is licensed under the Creative Commons [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/) license.
|
||||
Any runnable computer code or Sass/CSS definitions are licensed under the [GNU General Public License v3.0](https://www.gnu.org/licenses/gpl-3.0.html)
|
||||
# Specification
|
||||
## Dependencies
|
||||
You will need the following tools to render and upload the site
|
||||
- [Neocities CLI](https://neocities.org/cli)
|
||||
- [RedCloth](http://redcloth.org/)
|
||||
- [org-ruby](http://github.com/bdewey/org-ruby)
|
||||
- [comrak](https://github.com/kivikakk/comrak)
|
||||
## `Makefile`
|
||||
Wraps `render.sh` for the most part.
|
||||
### Makefile Options
|
||||
#### `list`
|
||||
Lists all components in a heading-annotated list
|
||||
#### `list-{doc,sass,dir,rest}`
|
||||
Lists markup files, sass files, directories, and other files respectively.
|
||||
#### `clean`
|
||||
Removes the `out/` directory that is generated on running of `render.sh`.
|
||||
## `render.sh`
|
||||
The primary worker script, sets up the directory structure, transpiles the markup, then the Sass, then copies the contents of `in/` to `out/`
|
2
awk/getlinks.awk
Normal file
2
awk/getlinks.awk
Normal file
@ -0,0 +1,2 @@
|
||||
BEGIN{FS=","}
|
||||
{print "<a href=\"" $1 "\">" $2 "</a>"}
|
7
awk/getsd.awk
Normal file
7
awk/getsd.awk
Normal file
@ -0,0 +1,7 @@
|
||||
#!/usr/bin/awk
|
||||
BEGIN{FS="/";x=2}
|
||||
function none() {print "main";exit}
|
||||
NF==1{none()}
|
||||
/\.\//{x++}
|
||||
$x~/\.(txti|html|org|md)/{none()}
|
||||
{if($x=="dnd")none();print $x;exit}
|
6
build.sh
6
build.sh
@ -1,6 +0,0 @@
|
||||
if ! zola >& /dev/null; then
|
||||
echo "Please install Zola to compile this work."
|
||||
echo "See: https://www.getzola.org/"
|
||||
fi
|
||||
zola build
|
||||
find public -type f -name "*.html" -exec sed -i '/^$/d' {} +
|
@ -1,7 +0,0 @@
|
||||
base_url = "https://makina.neocities.org/"
|
||||
theme = "book"
|
||||
compile_sass = true
|
||||
build_search_index = true
|
||||
[markdown]
|
||||
highlight_code = true
|
||||
[extra]
|
2
dat/ignore.txt
Normal file
2
dat/ignore.txt
Normal file
@ -0,0 +1,2 @@
|
||||
css/extra.scss
|
||||
dnd/template.org
|
2
dat/links.csv
Normal file
2
dat/links.csv
Normal file
@ -0,0 +1,2 @@
|
||||
/,Home
|
||||
https://atlas48.sdf.org/,Blog
|
|
3
dat/title.csv
Normal file
3
dat/title.csv
Normal file
@ -0,0 +1,3 @@
|
||||
not_found.html,"404 - Page Not Found"
|
||||
doc.html,"Atlas48's Archives: Git Readme"
|
||||
ee/index.txti,"Elysium's Edge Index"
|
|
19
gensimap.sh
Executable file
19
gensimap.sh
Executable file
@ -0,0 +1,19 @@
|
||||
#!/bin/bash
|
||||
# gensimap.sh: Generate a sitemap for my website.
|
||||
# v2.0p1
|
||||
function inf { 1>&2 echo -e "\x1B[1;32mINF\x1B[0m: $*"; }
|
||||
function r { echo $@ >> out/sitemap.xml; }
|
||||
inf "Generating Sitemap..."
|
||||
if test -f out/sitemap.xml; then
|
||||
inf "Overwriting current sitemap..."
|
||||
sed -i d sitemap.xml
|
||||
fi
|
||||
r '<?xml version="1.0" encoding="UTF-8"?>'
|
||||
r '<urlset xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.sitemaps.org/schemas/sitemap/0.9 http://www.sitemaps.org/schemas/sitemap/0.9/sitemap.xsd" xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">'
|
||||
for i in `find in -type f -name '*.html'`; do
|
||||
r "<url>"
|
||||
r "<loc>https://atlas48.neocities.org/$i</loc>"
|
||||
r "<lastmod>$(date +"%Y-%M-%d" -r $i)</lastmod>"
|
||||
r "</url>"
|
||||
done
|
||||
r "</urlset>"
|
6
m4/lib.m4
Normal file
6
m4/lib.m4
Normal file
@ -0,0 +1,6 @@
|
||||
divert(-1)
|
||||
# extra macros for site structure
|
||||
define(`_ytv',`<iframe width="ifdef(`$3',$1,560)" height="ifdef(`$3',$3,315)" src="$1" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>')
|
||||
define(`_wrap',<$1>$2</$1>)
|
||||
define(`_empty',`')
|
||||
divert`'dnl
|
25
m4/main.html.m4
Normal file
25
m4/main.html.m4
Normal file
@ -0,0 +1,25 @@
|
||||
dnl template.m4.html v2.0-p1
|
||||
dnl Part of the tape-and-string suite used to construct the website
|
||||
ifdef(`DEBUG',`traceon')dnl
|
||||
ifdef(`_INFILE',`dnl',`errprint(`Macro _INFILE is not defined')m4exit(1)')
|
||||
changequote(`[',`]')dnl
|
||||
ifdef([TITLE],[define([TITLE], [The Great Datum])dnl)],[define([TITLE],[The Great Datum])])
|
||||
changequote([`],['])dnl
|
||||
include(`m4/lib.m4')dnl
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<style>
|
||||
@import url("/css/CSSI().css");
|
||||
</style>
|
||||
<title>TITLE</title>
|
||||
</head>
|
||||
<body>
|
||||
<div class="header">
|
||||
esyscmd(`awk -f awk/getlinks.awk dat/links.csv')dnl
|
||||
</div>
|
||||
<div class="content">
|
||||
esyscmd(`./tape.sh' _INFILE)dnl
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
56
pfiles.rb
Executable file
56
pfiles.rb
Executable file
@ -0,0 +1,56 @@
|
||||
#!/usr/bin/ruby
|
||||
# pfiles.rb
|
||||
# v1.0-p3
|
||||
require 'find'
|
||||
ignore=!File.file?('dat/ignore.txt') ? [] : File.readlines('dat/ignore.txt')
|
||||
if ignore != []
|
||||
ignore.map! do |i|
|
||||
"in/#{i}"
|
||||
end
|
||||
end
|
||||
class Enumerator
|
||||
def collect
|
||||
out=Array.new
|
||||
for i in self
|
||||
out.push(i)
|
||||
end
|
||||
return out
|
||||
end
|
||||
end
|
||||
list=Find.find('in')
|
||||
l=list.collect
|
||||
case ARGV.first
|
||||
when "doc"
|
||||
for i in l do
|
||||
next if ignore.include?(i)
|
||||
if /\.(txti|org|md|html)$/.match?(i)
|
||||
print i
|
||||
print ' ' unless i==l.last
|
||||
end
|
||||
end
|
||||
when "sass"
|
||||
for i in l do
|
||||
next if ignore.include?(i)
|
||||
if /\.s[ac]ss$/.match?(i)
|
||||
print i
|
||||
print ' ' unless i==l.last
|
||||
end
|
||||
end
|
||||
when "dir"
|
||||
for i in l do
|
||||
next if ignore.include?(i)
|
||||
if File.directory?(i)
|
||||
print i
|
||||
print ' ' unless i==l.last
|
||||
end
|
||||
end
|
||||
when "rest"
|
||||
for i in l do
|
||||
next if ignore.include?(i)
|
||||
unless /\.(s[ac]ss|txti|org|md)$/.match?(i) or File.directory(i)
|
||||
print i
|
||||
print ' ' unless i==l.last
|
||||
end
|
||||
end
|
||||
else
|
||||
end
|
136
render.sh
Executable file
136
render.sh
Executable file
@ -0,0 +1,136 @@
|
||||
#!/bin/bash
|
||||
# render.sh: part of the tape-and-string framework.
|
||||
# v3.4-p6
|
||||
#B: Load
|
||||
enable -f /usr/lib/bash/csv csv
|
||||
declare -A title
|
||||
#E: Load
|
||||
#B: Definition
|
||||
function inf { 1>&2 echo -e "\x1B[1;32mINF\x1B[0m: $*"; }
|
||||
function wrn { 1>&2 echo -e "\x1B[1;93mWRN\x1B[0m: $*"; }
|
||||
function err { 1>&2 echo -e "\x1B[1;31mERR\x1B[0m: $*"; }
|
||||
function dirs {
|
||||
if test -d out; then
|
||||
wrn "Directory 'out' already exists."
|
||||
return 0
|
||||
fi
|
||||
local i o dir
|
||||
dir=(`./pfiles.rb dir`)
|
||||
inf "Creating directory structure..."
|
||||
echo ${dir[@]}
|
||||
for i in ${dir[@]}; do
|
||||
o="${i/in/out}"
|
||||
mkdir -pv $o
|
||||
done
|
||||
}
|
||||
function docs {
|
||||
load_title
|
||||
if ! test -d out; then
|
||||
err "Cannot render, directory 'out' does not exist, run ./render.sh dir"
|
||||
return 1
|
||||
fi
|
||||
local i o doc
|
||||
doc=(`./pfiles.rb doc`)
|
||||
inf "Rendering document files..."
|
||||
for i in ${doc[@]}; do
|
||||
o="${i/in/out}"
|
||||
o="${o%.*}.html"
|
||||
echo "'$i' -> '$o'"
|
||||
if test -z "${title[$i]}"; then
|
||||
m4 -D_INFILE="$i" -DCSSI=$(awk -f awk/getsd.awk <<< "$i") m4/main.html.m4 > $o
|
||||
else
|
||||
m4 -D_INFILE="$i" -DCSSI=$(awk -f awk/getsd.awk <<< "$i") -DTITLE="${title[$i]}" m4/main.html.m4 > $o
|
||||
fi
|
||||
done
|
||||
}
|
||||
function sass {
|
||||
if ! test -d out; then
|
||||
err "Cannot render, directory 'out' does not exist, run ./render.sh dir"
|
||||
return 1
|
||||
fi
|
||||
local i o sass
|
||||
sass=(`./pfiles.rb sass`)
|
||||
inf "Rendering sass files..."
|
||||
if [ ${#sass[@]} -eq 0 ]; then
|
||||
inf "No .sass files detected, skipping"
|
||||
return 0
|
||||
else
|
||||
for i in ${sass[@]}; do
|
||||
o="${i/in/out}"
|
||||
o="${o/.s[ac]/.c}"
|
||||
echo "'$i' -> '$o'"
|
||||
sassc -t expanded -a $i | sed '/^$/d' > $o
|
||||
done
|
||||
fi
|
||||
}
|
||||
function other {
|
||||
if ! test -d out; then
|
||||
err "Cannot render, directory 'out' does not exist, run ./render.sh dir"
|
||||
return 1
|
||||
fi
|
||||
inf "Copying other files..."
|
||||
cp -rv 'in'/* out/
|
||||
}
|
||||
function sitemap {
|
||||
./gensimap.sh
|
||||
}
|
||||
function all {
|
||||
load_title
|
||||
dirs
|
||||
docs
|
||||
sass
|
||||
other
|
||||
}
|
||||
function info {
|
||||
load_title
|
||||
local i
|
||||
echo "* \$ignore"
|
||||
if [ ${#ignore[@]} -eq 0 ]; then
|
||||
echo null
|
||||
else
|
||||
for i in ${ignore[@]}; do
|
||||
echo "- $i"
|
||||
done
|
||||
fi
|
||||
echo "* \$titles"
|
||||
for i in ${!title[@]}; do
|
||||
echo " - $i :: ${title[$i]}"
|
||||
done
|
||||
}
|
||||
function load_title {
|
||||
local ii
|
||||
while read -r ii; do
|
||||
csv -a i "$ii"
|
||||
title[in/${i[0]}]=${i[1]}
|
||||
done < dat/title.csv
|
||||
}
|
||||
#E: Definition
|
||||
#B: Logic
|
||||
#B: Logic/LoadDefs
|
||||
#B: Logic/LoadDefs/ignore
|
||||
if test -f ignore.txt; then
|
||||
while read -r i; do
|
||||
ignore+=(in/$i)
|
||||
done < dat/ignore.txt
|
||||
fi
|
||||
#E: Logic/LoadDefs/ignore
|
||||
#E: Logic/LoadDefs
|
||||
if test -z "$*"; then
|
||||
all
|
||||
exit $?
|
||||
fi
|
||||
case $1 in
|
||||
dir) dirs;;
|
||||
doc) docs;;
|
||||
docs) docs;;
|
||||
s[ac]ss) sass;;
|
||||
other) other;;
|
||||
rest) other;;
|
||||
info) info;;
|
||||
sitemap) sitemap;;
|
||||
vall) info; all;;
|
||||
all) all;;
|
||||
*) all;;
|
||||
esac
|
||||
#E: Logic
|
||||
exit $?
|
22
tape.sh
Executable file
22
tape.sh
Executable file
@ -0,0 +1,22 @@
|
||||
#!/bin/bash
|
||||
function inf { 1>&2 echo -e "\x1B[1;32mINF\x1B[0m: $*"; }
|
||||
function wrn { 1>&2 echo -e "\x1B[1;93mWRN\x1B[0m: $*"; }
|
||||
function err { 1>&2 echo -e "\x1B[1;31mERR\x1B[0m: $*"; }
|
||||
if test -d "$1"; then
|
||||
err "tape: Passed directory, $1"
|
||||
return 1
|
||||
elif test -z "$*"; then
|
||||
err "No files passed."
|
||||
exit 1
|
||||
fi
|
||||
case $1 in
|
||||
_INFILE) err "Passed raw macro."; exit 1;;
|
||||
*.txti) redcloth "$1" | sed '/^$/d;s/^\s\{1,\}//';;
|
||||
*.org) org-ruby --translate html "$1" | sed '/^$/d;s/^\s\{1,\}//';;
|
||||
*.md) comrak --gfm "$1" ;;
|
||||
*.html) cat $1 ;;
|
||||
*.s[ac]ss) err "Told to render $1, shouldn't happen"; exit 1 ;;
|
||||
*.sh) (inf "Running shellscript $1, I hope you know what you're doing..."; source $1 );;
|
||||
*) pandoc --columns 168 -t html "$1" || echo "Skipping $i, unknown format" ;;
|
||||
esac
|
||||
|
@ -1 +0,0 @@
|
||||
Subproject commit f84330c575f53f3ac017e71190b2275eaa804ae7
|
Loading…
Reference in New Issue
Block a user