commit
83cf4605cf
|
@ -0,0 +1,12 @@
|
|||
root = true
|
||||
|
||||
[*]
|
||||
indent_style = space
|
||||
indent_size = 2
|
||||
end_of_line = lf
|
||||
charset = utf-8
|
||||
trim_trailing_whitespace = true
|
||||
insert_final_newline = true
|
||||
|
||||
[*.json]
|
||||
indent_style = tab
|
|
@ -0,0 +1,3 @@
|
|||
/node_modules/
|
||||
/build/
|
||||
/public/
|
|
@ -0,0 +1,3 @@
|
|||
{
|
||||
"extends": "stylelint-config-standard-scss"
|
||||
}
|
|
@ -0,0 +1,373 @@
|
|||
Mozilla Public License Version 2.0
|
||||
==================================
|
||||
|
||||
1. Definitions
|
||||
--------------
|
||||
|
||||
1.1. "Contributor"
|
||||
means each individual or legal entity that creates, contributes to
|
||||
the creation of, or owns Covered Software.
|
||||
|
||||
1.2. "Contributor Version"
|
||||
means the combination of the Contributions of others (if any) used
|
||||
by a Contributor and that particular Contributor's Contribution.
|
||||
|
||||
1.3. "Contribution"
|
||||
means Covered Software of a particular Contributor.
|
||||
|
||||
1.4. "Covered Software"
|
||||
means Source Code Form to which the initial Contributor has attached
|
||||
the notice in Exhibit A, the Executable Form of such Source Code
|
||||
Form, and Modifications of such Source Code Form, in each case
|
||||
including portions thereof.
|
||||
|
||||
1.5. "Incompatible With Secondary Licenses"
|
||||
means
|
||||
|
||||
(a) that the initial Contributor has attached the notice described
|
||||
in Exhibit B to the Covered Software; or
|
||||
|
||||
(b) that the Covered Software was made available under the terms of
|
||||
version 1.1 or earlier of the License, but not also under the
|
||||
terms of a Secondary License.
|
||||
|
||||
1.6. "Executable Form"
|
||||
means any form of the work other than Source Code Form.
|
||||
|
||||
1.7. "Larger Work"
|
||||
means a work that combines Covered Software with other material, in
|
||||
a separate file or files, that is not Covered Software.
|
||||
|
||||
1.8. "License"
|
||||
means this document.
|
||||
|
||||
1.9. "Licensable"
|
||||
means having the right to grant, to the maximum extent possible,
|
||||
whether at the time of the initial grant or subsequently, any and
|
||||
all of the rights conveyed by this License.
|
||||
|
||||
1.10. "Modifications"
|
||||
means any of the following:
|
||||
|
||||
(a) any file in Source Code Form that results from an addition to,
|
||||
deletion from, or modification of the contents of Covered
|
||||
Software; or
|
||||
|
||||
(b) any new file in Source Code Form that contains any Covered
|
||||
Software.
|
||||
|
||||
1.11. "Patent Claims" of a Contributor
|
||||
means any patent claim(s), including without limitation, method,
|
||||
process, and apparatus claims, in any patent Licensable by such
|
||||
Contributor that would be infringed, but for the grant of the
|
||||
License, by the making, using, selling, offering for sale, having
|
||||
made, import, or transfer of either its Contributions or its
|
||||
Contributor Version.
|
||||
|
||||
1.12. "Secondary License"
|
||||
means either the GNU General Public License, Version 2.0, the GNU
|
||||
Lesser General Public License, Version 2.1, the GNU Affero General
|
||||
Public License, Version 3.0, or any later versions of those
|
||||
licenses.
|
||||
|
||||
1.13. "Source Code Form"
|
||||
means the form of the work preferred for making modifications.
|
||||
|
||||
1.14. "You" (or "Your")
|
||||
means an individual or a legal entity exercising rights under this
|
||||
License. For legal entities, "You" includes any entity that
|
||||
controls, is controlled by, or is under common control with You. For
|
||||
purposes of this definition, "control" means (a) the power, direct
|
||||
or indirect, to cause the direction or management of such entity,
|
||||
whether by contract or otherwise, or (b) ownership of more than
|
||||
fifty percent (50%) of the outstanding shares or beneficial
|
||||
ownership of such entity.
|
||||
|
||||
2. License Grants and Conditions
|
||||
--------------------------------
|
||||
|
||||
2.1. Grants
|
||||
|
||||
Each Contributor hereby grants You a world-wide, royalty-free,
|
||||
non-exclusive license:
|
||||
|
||||
(a) under intellectual property rights (other than patent or trademark)
|
||||
Licensable by such Contributor to use, reproduce, make available,
|
||||
modify, display, perform, distribute, and otherwise exploit its
|
||||
Contributions, either on an unmodified basis, with Modifications, or
|
||||
as part of a Larger Work; and
|
||||
|
||||
(b) under Patent Claims of such Contributor to make, use, sell, offer
|
||||
for sale, have made, import, and otherwise transfer either its
|
||||
Contributions or its Contributor Version.
|
||||
|
||||
2.2. Effective Date
|
||||
|
||||
The licenses granted in Section 2.1 with respect to any Contribution
|
||||
become effective for each Contribution on the date the Contributor first
|
||||
distributes such Contribution.
|
||||
|
||||
2.3. Limitations on Grant Scope
|
||||
|
||||
The licenses granted in this Section 2 are the only rights granted under
|
||||
this License. No additional rights or licenses will be implied from the
|
||||
distribution or licensing of Covered Software under this License.
|
||||
Notwithstanding Section 2.1(b) above, no patent license is granted by a
|
||||
Contributor:
|
||||
|
||||
(a) for any code that a Contributor has removed from Covered Software;
|
||||
or
|
||||
|
||||
(b) for infringements caused by: (i) Your and any other third party's
|
||||
modifications of Covered Software, or (ii) the combination of its
|
||||
Contributions with other software (except as part of its Contributor
|
||||
Version); or
|
||||
|
||||
(c) under Patent Claims infringed by Covered Software in the absence of
|
||||
its Contributions.
|
||||
|
||||
This License does not grant any rights in the trademarks, service marks,
|
||||
or logos of any Contributor (except as may be necessary to comply with
|
||||
the notice requirements in Section 3.4).
|
||||
|
||||
2.4. Subsequent Licenses
|
||||
|
||||
No Contributor makes additional grants as a result of Your choice to
|
||||
distribute the Covered Software under a subsequent version of this
|
||||
License (see Section 10.2) or under the terms of a Secondary License (if
|
||||
permitted under the terms of Section 3.3).
|
||||
|
||||
2.5. Representation
|
||||
|
||||
Each Contributor represents that the Contributor believes its
|
||||
Contributions are its original creation(s) or it has sufficient rights
|
||||
to grant the rights to its Contributions conveyed by this License.
|
||||
|
||||
2.6. Fair Use
|
||||
|
||||
This License is not intended to limit any rights You have under
|
||||
applicable copyright doctrines of fair use, fair dealing, or other
|
||||
equivalents.
|
||||
|
||||
2.7. Conditions
|
||||
|
||||
Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
|
||||
in Section 2.1.
|
||||
|
||||
3. Responsibilities
|
||||
-------------------
|
||||
|
||||
3.1. Distribution of Source Form
|
||||
|
||||
All distribution of Covered Software in Source Code Form, including any
|
||||
Modifications that You create or to which You contribute, must be under
|
||||
the terms of this License. You must inform recipients that the Source
|
||||
Code Form of the Covered Software is governed by the terms of this
|
||||
License, and how they can obtain a copy of this License. You may not
|
||||
attempt to alter or restrict the recipients' rights in the Source Code
|
||||
Form.
|
||||
|
||||
3.2. Distribution of Executable Form
|
||||
|
||||
If You distribute Covered Software in Executable Form then:
|
||||
|
||||
(a) such Covered Software must also be made available in Source Code
|
||||
Form, as described in Section 3.1, and You must inform recipients of
|
||||
the Executable Form how they can obtain a copy of such Source Code
|
||||
Form by reasonable means in a timely manner, at a charge no more
|
||||
than the cost of distribution to the recipient; and
|
||||
|
||||
(b) You may distribute such Executable Form under the terms of this
|
||||
License, or sublicense it under different terms, provided that the
|
||||
license for the Executable Form does not attempt to limit or alter
|
||||
the recipients' rights in the Source Code Form under this License.
|
||||
|
||||
3.3. Distribution of a Larger Work
|
||||
|
||||
You may create and distribute a Larger Work under terms of Your choice,
|
||||
provided that You also comply with the requirements of this License for
|
||||
the Covered Software. If the Larger Work is a combination of Covered
|
||||
Software with a work governed by one or more Secondary Licenses, and the
|
||||
Covered Software is not Incompatible With Secondary Licenses, this
|
||||
License permits You to additionally distribute such Covered Software
|
||||
under the terms of such Secondary License(s), so that the recipient of
|
||||
the Larger Work may, at their option, further distribute the Covered
|
||||
Software under the terms of either this License or such Secondary
|
||||
License(s).
|
||||
|
||||
3.4. Notices
|
||||
|
||||
You may not remove or alter the substance of any license notices
|
||||
(including copyright notices, patent notices, disclaimers of warranty,
|
||||
or limitations of liability) contained within the Source Code Form of
|
||||
the Covered Software, except that You may alter any license notices to
|
||||
the extent required to remedy known factual inaccuracies.
|
||||
|
||||
3.5. Application of Additional Terms
|
||||
|
||||
You may choose to offer, and to charge a fee for, warranty, support,
|
||||
indemnity or liability obligations to one or more recipients of Covered
|
||||
Software. However, You may do so only on Your own behalf, and not on
|
||||
behalf of any Contributor. You must make it absolutely clear that any
|
||||
such warranty, support, indemnity, or liability obligation is offered by
|
||||
You alone, and You hereby agree to indemnify every Contributor for any
|
||||
liability incurred by such Contributor as a result of warranty, support,
|
||||
indemnity or liability terms You offer. You may include additional
|
||||
disclaimers of warranty and limitations of liability specific to any
|
||||
jurisdiction.
|
||||
|
||||
4. Inability to Comply Due to Statute or Regulation
|
||||
---------------------------------------------------
|
||||
|
||||
If it is impossible for You to comply with any of the terms of this
|
||||
License with respect to some or all of the Covered Software due to
|
||||
statute, judicial order, or regulation then You must: (a) comply with
|
||||
the terms of this License to the maximum extent possible; and (b)
|
||||
describe the limitations and the code they affect. Such description must
|
||||
be placed in a text file included with all distributions of the Covered
|
||||
Software under this License. Except to the extent prohibited by statute
|
||||
or regulation, such description must be sufficiently detailed for a
|
||||
recipient of ordinary skill to be able to understand it.
|
||||
|
||||
5. Termination
|
||||
--------------
|
||||
|
||||
5.1. The rights granted under this License will terminate automatically
|
||||
if You fail to comply with any of its terms. However, if You become
|
||||
compliant, then the rights granted under this License from a particular
|
||||
Contributor are reinstated (a) provisionally, unless and until such
|
||||
Contributor explicitly and finally terminates Your grants, and (b) on an
|
||||
ongoing basis, if such Contributor fails to notify You of the
|
||||
non-compliance by some reasonable means prior to 60 days after You have
|
||||
come back into compliance. Moreover, Your grants from a particular
|
||||
Contributor are reinstated on an ongoing basis if such Contributor
|
||||
notifies You of the non-compliance by some reasonable means, this is the
|
||||
first time You have received notice of non-compliance with this License
|
||||
from such Contributor, and You become compliant prior to 30 days after
|
||||
Your receipt of the notice.
|
||||
|
||||
5.2. If You initiate litigation against any entity by asserting a patent
|
||||
infringement claim (excluding declaratory judgment actions,
|
||||
counter-claims, and cross-claims) alleging that a Contributor Version
|
||||
directly or indirectly infringes any patent, then the rights granted to
|
||||
You by any and all Contributors for the Covered Software under Section
|
||||
2.1 of this License shall terminate.
|
||||
|
||||
5.3. In the event of termination under Sections 5.1 or 5.2 above, all
|
||||
end user license agreements (excluding distributors and resellers) which
|
||||
have been validly granted by You or Your distributors under this License
|
||||
prior to termination shall survive termination.
|
||||
|
||||
************************************************************************
|
||||
* *
|
||||
* 6. Disclaimer of Warranty *
|
||||
* ------------------------- *
|
||||
* *
|
||||
* Covered Software is provided under this License on an "as is" *
|
||||
* basis, without warranty of any kind, either expressed, implied, or *
|
||||
* statutory, including, without limitation, warranties that the *
|
||||
* Covered Software is free of defects, merchantable, fit for a *
|
||||
* particular purpose or non-infringing. The entire risk as to the *
|
||||
* quality and performance of the Covered Software is with You. *
|
||||
* Should any Covered Software prove defective in any respect, You *
|
||||
* (not any Contributor) assume the cost of any necessary servicing, *
|
||||
* repair, or correction. This disclaimer of warranty constitutes an *
|
||||
* essential part of this License. No use of any Covered Software is *
|
||||
* authorized under this License except under this disclaimer. *
|
||||
* *
|
||||
************************************************************************
|
||||
|
||||
************************************************************************
|
||||
* *
|
||||
* 7. Limitation of Liability *
|
||||
* -------------------------- *
|
||||
* *
|
||||
* Under no circumstances and under no legal theory, whether tort *
|
||||
* (including negligence), contract, or otherwise, shall any *
|
||||
* Contributor, or anyone who distributes Covered Software as *
|
||||
* permitted above, be liable to You for any direct, indirect, *
|
||||
* special, incidental, or consequential damages of any character *
|
||||
* including, without limitation, damages for lost profits, loss of *
|
||||
* goodwill, work stoppage, computer failure or malfunction, or any *
|
||||
* and all other commercial damages or losses, even if such party *
|
||||
* shall have been informed of the possibility of such damages. This *
|
||||
* limitation of liability shall not apply to liability for death or *
|
||||
* personal injury resulting from such party's negligence to the *
|
||||
* extent applicable law prohibits such limitation. Some *
|
||||
* jurisdictions do not allow the exclusion or limitation of *
|
||||
* incidental or consequential damages, so this exclusion and *
|
||||
* limitation may not apply to You. *
|
||||
* *
|
||||
************************************************************************
|
||||
|
||||
8. Litigation
|
||||
-------------
|
||||
|
||||
Any litigation relating to this License may be brought only in the
|
||||
courts of a jurisdiction where the defendant maintains its principal
|
||||
place of business and such litigation shall be governed by laws of that
|
||||
jurisdiction, without reference to its conflict-of-law provisions.
|
||||
Nothing in this Section shall prevent a party's ability to bring
|
||||
cross-claims or counter-claims.
|
||||
|
||||
9. Miscellaneous
|
||||
----------------
|
||||
|
||||
This License represents the complete agreement concerning the subject
|
||||
matter hereof. If any provision of this License is held to be
|
||||
unenforceable, such provision shall be reformed only to the extent
|
||||
necessary to make it enforceable. Any law or regulation which provides
|
||||
that the language of a contract shall be construed against the drafter
|
||||
shall not be used to construe this License against a Contributor.
|
||||
|
||||
10. Versions of the License
|
||||
---------------------------
|
||||
|
||||
10.1. New Versions
|
||||
|
||||
Mozilla Foundation is the license steward. Except as provided in Section
|
||||
10.3, no one other than the license steward has the right to modify or
|
||||
publish new versions of this License. Each version will be given a
|
||||
distinguishing version number.
|
||||
|
||||
10.2. Effect of New Versions
|
||||
|
||||
You may distribute the Covered Software under the terms of the version
|
||||
of the License under which You originally received the Covered Software,
|
||||
or under the terms of any subsequent version published by the license
|
||||
steward.
|
||||
|
||||
10.3. Modified Versions
|
||||
|
||||
If you create software not governed by this License, and you want to
|
||||
create a new license for such software, you may create and use a
|
||||
modified version of this License if you rename the license and remove
|
||||
any references to the name of the license steward (except to note that
|
||||
such modified license differs from this License).
|
||||
|
||||
10.4. Distributing Source Code Form that is Incompatible With Secondary
|
||||
Licenses
|
||||
|
||||
If You choose to distribute Source Code Form that is Incompatible With
|
||||
Secondary Licenses under the terms of this version of the License, the
|
||||
notice described in Exhibit B of this License must be attached.
|
||||
|
||||
Exhibit A - Source Code Form License Notice
|
||||
-------------------------------------------
|
||||
|
||||
This Source Code Form is subject to the terms of the Mozilla Public
|
||||
License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||
file, You can obtain one at https://mozilla.org/MPL/2.0/.
|
||||
|
||||
If it is not possible or desirable to put the notice in a particular
|
||||
file, then You may include the notice in a location (such as a LICENSE
|
||||
file in a relevant directory) where a recipient would be likely to look
|
||||
for such a notice.
|
||||
|
||||
You may add additional accurate notices of copyright ownership.
|
||||
|
||||
Exhibit B - "Incompatible With Secondary Licenses" Notice
|
||||
---------------------------------------------------------
|
||||
|
||||
This Source Code Form is "Incompatible With Secondary Licenses", as
|
||||
defined by the Mozilla Public License, v. 2.0.
|
|
@ -0,0 +1 @@
|
|||
= docs-ui
|
|
@ -0,0 +1,19 @@
|
|||
{
|
||||
"formatter": {
|
||||
"indentStyle": "space",
|
||||
"indentWidth": 2
|
||||
},
|
||||
"javascript": {
|
||||
"formatter": {
|
||||
"quoteStyle": "single"
|
||||
}
|
||||
},
|
||||
"json": {
|
||||
"formatter": {
|
||||
"indentStyle": "tab"
|
||||
},
|
||||
"parser": {
|
||||
"allowComments": true
|
||||
}
|
||||
}
|
||||
}
|
|
@ -0,0 +1,61 @@
|
|||
{
|
||||
"nodes": {
|
||||
"flake-utils": {
|
||||
"inputs": {
|
||||
"systems": "systems"
|
||||
},
|
||||
"locked": {
|
||||
"lastModified": 1705309234,
|
||||
"narHash": "sha256-uNRRNRKmJyCRC/8y1RqBkqWBLM034y4qN7EprSdmgyA=",
|
||||
"owner": "numtide",
|
||||
"repo": "flake-utils",
|
||||
"rev": "1ef2e671c3b0c19053962c07dbda38332dcebf26",
|
||||
"type": "github"
|
||||
},
|
||||
"original": {
|
||||
"owner": "numtide",
|
||||
"repo": "flake-utils",
|
||||
"type": "github"
|
||||
}
|
||||
},
|
||||
"nixpkgs": {
|
||||
"locked": {
|
||||
"lastModified": 1706191920,
|
||||
"narHash": "sha256-eLihrZAPZX0R6RyM5fYAWeKVNuQPYjAkCUBr+JNvtdE=",
|
||||
"owner": "NixOS",
|
||||
"repo": "nixpkgs",
|
||||
"rev": "ae5c332cbb5827f6b1f02572496b141021de335f",
|
||||
"type": "github"
|
||||
},
|
||||
"original": {
|
||||
"owner": "NixOS",
|
||||
"ref": "nixos-unstable",
|
||||
"repo": "nixpkgs",
|
||||
"type": "github"
|
||||
}
|
||||
},
|
||||
"root": {
|
||||
"inputs": {
|
||||
"flake-utils": "flake-utils",
|
||||
"nixpkgs": "nixpkgs"
|
||||
}
|
||||
},
|
||||
"systems": {
|
||||
"locked": {
|
||||
"lastModified": 1681028828,
|
||||
"narHash": "sha256-Vy1rq5AaRuLzOxct8nz4T6wlgyUR7zLU309k9mBC768=",
|
||||
"owner": "nix-systems",
|
||||
"repo": "default",
|
||||
"rev": "da67096a3b9bf56a91d16901293e51ba5b49a27e",
|
||||
"type": "github"
|
||||
},
|
||||
"original": {
|
||||
"owner": "nix-systems",
|
||||
"repo": "default",
|
||||
"type": "github"
|
||||
}
|
||||
}
|
||||
},
|
||||
"root": "root",
|
||||
"version": 7
|
||||
}
|
|
@ -0,0 +1,41 @@
|
|||
{
|
||||
inputs = {
|
||||
nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
|
||||
flake-utils.url = "github:numtide/flake-utils";
|
||||
};
|
||||
|
||||
outputs = { nixpkgs, flake-utils, ... }:
|
||||
flake-utils.lib.eachDefaultSystem (system:
|
||||
let
|
||||
pkgs = nixpkgs.legacyPackages.${system};
|
||||
|
||||
pnpm = "${pkgs.nodePackages.pnpm}/bin/pnpm";
|
||||
biome = "${pkgs.biome}/bin/biome";
|
||||
in
|
||||
{
|
||||
# TODO: add `apps` target to build the bundle using Vite
|
||||
|
||||
formatter = pkgs.writeShellScriptBin "biome-fmt" ''
|
||||
${biome} check --apply .
|
||||
'';
|
||||
|
||||
checks = with pkgs; {
|
||||
stylelint = writeShellScriptBin "stylelint" ''
|
||||
${pnpm} stylelint src/css/*.scss
|
||||
'';
|
||||
biome = writeShellScriptBin "biome-check" ''
|
||||
${biome} check .
|
||||
'';
|
||||
};
|
||||
|
||||
devShells.default = with pkgs; mkShellNoCC {
|
||||
name = "docs-ui";
|
||||
packages = [
|
||||
nodePackages.nodejs
|
||||
nodePackages.pnpm
|
||||
biome
|
||||
];
|
||||
};
|
||||
}
|
||||
);
|
||||
}
|
|
@ -0,0 +1,21 @@
|
|||
{
|
||||
"name": "docs-ui",
|
||||
"description": "Antora UI bundle for https://docs.folliehiyuki.com",
|
||||
"homepage": "https://gitlab.com/FollieHiyuki/docs-ui",
|
||||
"license": "MPL-2.0",
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "https://gitlab.com/FollieHiyuki/docs-ui.git"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">= 18.0.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@glint/core": "^1.3.0",
|
||||
"highlight.js": "^11.9.0",
|
||||
"stylelint": "^16.2.0",
|
||||
"stylelint-config-standard-scss": "^13.0.0",
|
||||
"typescript": "^5.3.3",
|
||||
"vite": "^5.0.12"
|
||||
}
|
||||
}
|
File diff suppressed because it is too large
Load Diff
|
@ -0,0 +1,339 @@
|
|||
= Hardware and Software Requirements
|
||||
Author Name
|
||||
:idprefix:
|
||||
:idseparator: -
|
||||
:!example-caption:
|
||||
:!table-caption:
|
||||
:page-pagination:
|
||||
|
||||
[.float-group]
|
||||
--
|
||||
image:multirepo-ssg.svg[Multirepo SSG,180,135,float=right,role=float-gap]
|
||||
Platonem complectitur mediocritatem ea eos.
|
||||
Ei nonumy deseruisse ius.
|
||||
Mel id omnes verear.
|
||||
Vis no velit audiam, sonet <<dependencies,praesent>> eum ne.
|
||||
*Prompta eripuit* nec ad.
|
||||
Integer diam enim, dignissim eget eros et, ultricies mattis odio.
|
||||
--
|
||||
|
||||
Vestibulum consectetur nec urna a luctus.
|
||||
Quisque pharetra tristique arcu fringilla dapibus.
|
||||
https://example.org[Curabitur,role=unresolved] ut massa aliquam, cursus enim et, accumsan lectus.
|
||||
Mauris eget leo nunc, nec tempus mi? Curabitur id nisl mi, ut vulputate urna.
|
||||
|
||||
== Cu solet
|
||||
|
||||
Nominavi luptatum eos, an vim hinc philosophia intellegebat.
|
||||
Lorem pertinacia `expetenda` et nec, [.underline]#wisi# illud [.line-through]#sonet# qui ea.
|
||||
H~2~0.
|
||||
E = mc^2^.
|
||||
*Alphabet* *алфавит* _алфавит_ *_алфавит_*.
|
||||
Eum an doctus <<liber-recusabo,maiestatis efficiantur>>.
|
||||
Eu mea inani iriure.footnote:[Quisque porta facilisis tortor, vitae bibendum velit fringilla vitae! Lorem ipsum dolor sit amet, consectetur adipiscing elit.]
|
||||
|
||||
[,json]
|
||||
----
|
||||
{
|
||||
"name": "module-name",
|
||||
"version": "10.0.1",
|
||||
"description": "An example module to illustrate the usage of package.json",
|
||||
"author": "Author Name <author@example.com>",
|
||||
"scripts": {
|
||||
"test": "mocha",
|
||||
"lint": "eslint"
|
||||
}
|
||||
}
|
||||
----
|
||||
|
||||
.Example paragraph syntax
|
||||
[,asciidoc]
|
||||
----
|
||||
.Optional title
|
||||
[example]
|
||||
This is an example paragraph.
|
||||
----
|
||||
|
||||
.Optional title
|
||||
[example]
|
||||
This is an example paragraph.
|
||||
|
||||
.Summary *Spoiler Alert!*
|
||||
[%collapsible]
|
||||
====
|
||||
Details.
|
||||
|
||||
Loads of details.
|
||||
====
|
||||
|
||||
[,asciidoc]
|
||||
----
|
||||
Voila!
|
||||
----
|
||||
|
||||
.Result
|
||||
[%collapsible.result]
|
||||
====
|
||||
Voila!
|
||||
====
|
||||
|
||||
=== Some Code
|
||||
|
||||
How about some code?
|
||||
|
||||
[,js]
|
||||
----
|
||||
vfs
|
||||
.src('js/vendor/*.js', { cwd: 'src', cwdbase: true, read: false })
|
||||
.pipe(tap((file) => { // <.>
|
||||
file.contents = browserify(file.relative, { basedir: 'src', detectGlobals: false }).bundle()
|
||||
}))
|
||||
.pipe(buffer()) // <.>
|
||||
.pipe(uglify())
|
||||
.pipe(gulp.dest('build'))
|
||||
----
|
||||
<.> The `tap` function is used to wiretap the data in the pipe.
|
||||
<.> Wrap each streaming file in a buffer so the files can be processed by uglify.
|
||||
Uglify can only work with buffers, not streams.
|
||||
|
||||
Execute these commands to validate and build your site:
|
||||
|
||||
$ podman run -v $PWD:/antora:Z --rm -t antora/antora \
|
||||
version
|
||||
3.0.0
|
||||
$ podman run -v $PWD:/antora:Z --rm -it antora/antora \
|
||||
--clean \
|
||||
antora-playbook.yml
|
||||
|
||||
Cum dicat #putant# ne.
|
||||
Est in <<inline,reque>> homero principes, meis deleniti mediocrem ad has.
|
||||
Altera atomorum his ex, has cu elitr melius propriae.
|
||||
Eos suscipit scaevola at.
|
||||
|
||||
....
|
||||
pom.xml
|
||||
src/
|
||||
main/
|
||||
java/
|
||||
HelloWorld.java
|
||||
test/
|
||||
java/
|
||||
HelloWorldTest.java
|
||||
....
|
||||
|
||||
Eu mea munere vituperata constituam.
|
||||
|
||||
[%autowidth]
|
||||
|===
|
||||
|Input | Output | Example
|
||||
|
||||
m|"foo\nbar"
|
||||
l|foo
|
||||
bar
|
||||
a|
|
||||
[,ruby]
|
||||
----
|
||||
puts "foo\nbar"
|
||||
----
|
||||
|===
|
||||
|
||||
Here we just have some plain text.
|
||||
|
||||
[source]
|
||||
----
|
||||
plain text
|
||||
----
|
||||
|
||||
[.rolename]
|
||||
=== Liber recusabo
|
||||
|
||||
Select menu:File[Open Project] to open the project in your IDE.
|
||||
Per ea btn:[Cancel] inimicus.
|
||||
Ferri kbd:[F11] tacimates constituam sed ex, eu mea munere vituperata kbd:[Ctrl,T] constituam.
|
||||
|
||||
.Sidebar Title
|
||||
****
|
||||
Platonem complectitur mediocritatem ea eos.
|
||||
Ei nonumy deseruisse ius.
|
||||
Mel id omnes verear.
|
||||
|
||||
Altera atomorum his ex, has cu elitr melius propriae.
|
||||
Eos suscipit scaevola at.
|
||||
****
|
||||
|
||||
No sea, at invenire voluptaria mnesarchum has.
|
||||
Ex nam suas nemore dignissim, vel apeirian democritum et.
|
||||
At ornatus splendide sed, phaedrum omittantur usu an, vix an noster voluptatibus.
|
||||
|
||||
---
|
||||
|
||||
.Ordered list with customized numeration
|
||||
[upperalpha]
|
||||
. potenti donec cubilia tincidunt
|
||||
. etiam pulvinar inceptos velit quisque aptent himenaeos
|
||||
. lacus volutpat semper porttitor aliquet ornare primis nulla enim
|
||||
|
||||
Natum facilisis theophrastus an duo.
|
||||
No sea, at invenire voluptaria mnesarchum has.
|
||||
|
||||
.Unordered list with customized marker
|
||||
[square]
|
||||
* ultricies sociosqu tristique integer
|
||||
* lacus volutpat semper porttitor aliquet ornare primis nulla enim
|
||||
* etiam pulvinar inceptos velit quisque aptent himenaeos
|
||||
|
||||
Eu sed antiopam gloriatur.
|
||||
Ea mea agam graeci philosophia.
|
||||
|
||||
[circle]
|
||||
* circles
|
||||
** circles
|
||||
*** and more circles!
|
||||
|
||||
At ornatus splendide sed, phaedrum omittantur usu an, vix an noster voluptatibus.
|
||||
|
||||
* [ ] todo
|
||||
* [x] done!
|
||||
|
||||
Vis veri graeci legimus ad.
|
||||
|
||||
sed::
|
||||
splendide sed
|
||||
|
||||
mea::
|
||||
tad::
|
||||
agam graeci
|
||||
|
||||
Let's look at that another way.
|
||||
|
||||
[horizontal]
|
||||
sed::
|
||||
splendide sed
|
||||
|
||||
mea::
|
||||
agam graeci
|
||||
|
||||
At ornatus splendide sed.
|
||||
|
||||
.Library dependencies
|
||||
[#dependencies%autowidth%footer,stripes=hover]
|
||||
|===
|
||||
|Library |Version
|
||||
|
||||
|eslint
|
||||
|^1.7.3
|
||||
|
||||
|eslint-config-gulp
|
||||
|^2.0.0
|
||||
|
||||
|expect
|
||||
|^1.20.2
|
||||
|
||||
|istanbul
|
||||
|^0.4.3
|
||||
|
||||
|istanbul-coveralls
|
||||
|^1.0.3
|
||||
|
||||
|jscs
|
||||
|^2.3.5
|
||||
|
||||
h|Total
|
||||
|6
|
||||
|===
|
||||
|
||||
Cum dicat putant ne.
|
||||
Est in reque homero principes, meis deleniti mediocrem ad has.
|
||||
Altera atomorum his ex, has cu elitr melius propriae.
|
||||
Eos suscipit scaevola at.
|
||||
|
||||
[TIP]
|
||||
This oughta do it!
|
||||
|
||||
Cum dicat putant ne.
|
||||
Est in reque homero principes, meis deleniti mediocrem ad has.
|
||||
Altera atomorum his ex, has cu elitr melius propriae.
|
||||
Eos suscipit scaevola at.
|
||||
|
||||
[NOTE]
|
||||
====
|
||||
You've been down _this_ road before.
|
||||
====
|
||||
|
||||
Cum dicat putant ne.
|
||||
Est in reque homero principes, meis deleniti mediocrem ad has.
|
||||
Altera atomorum his ex, has cu elitr melius propriae.
|
||||
Eos suscipit scaevola at.
|
||||
|
||||
[WARNING]
|
||||
====
|
||||
Watch out!
|
||||
====
|
||||
|
||||
[CAUTION]
|
||||
====
|
||||
[#inline]#I wouldn't try that if I were you.#
|
||||
====
|
||||
|
||||
[IMPORTANT]
|
||||
====
|
||||
Don't forget this step!
|
||||
====
|
||||
|
||||
.Key Points to Remember
|
||||
[TIP]
|
||||
====
|
||||
If you installed the CLI and the default site generator globally, you can upgrade both of them with the same command.
|
||||
|
||||
$ npm i -g @antora/cli @antora/site-generator
|
||||
|
||||
Or you can install the metapackage to upgrade both packages at once.
|
||||
|
||||
$ npm i -g antora
|
||||
====
|
||||
|
||||
Nominavi luptatum eos, an vim hinc philosophia intellegebat.
|
||||
Eu mea inani iriure.
|
||||
|
||||
[discrete]
|
||||
== Voluptua singulis
|
||||
|
||||
Cum dicat putant ne.
|
||||
Est in reque homero principes, meis deleniti mediocrem ad has.
|
||||
Ex nam suas nemore dignissim, vel apeirian democritum et.
|
||||
|
||||
.Antora is a multi-repo documentation site generator
|
||||
image::multirepo-ssg.svg[Multirepo SSG,3000,opts=interactive]
|
||||
|
||||
Make the switch today!
|
||||
|
||||
.Full Circle with Jake Blauvelt
|
||||
video::300817511[vimeo,640,360,align=left]
|
||||
|
||||
[#english+中文]
|
||||
== English + 中文
|
||||
|
||||
Altera atomorum his ex, has cu elitr melius propriae.
|
||||
Eos suscipit scaevola at.
|
||||
|
||||
[,'Famous Person. Cum dicat putant ne.','Cum dicat putant ne. https://example.com[Famous Person Website]']
|
||||
____
|
||||
Lorem ipsum dolor sit amet, consectetur adipiscing elit.
|
||||
Mauris eget leo nunc, nec tempus mi? Curabitur id nisl mi, ut vulputate urna.
|
||||
Quisque porta facilisis tortor, vitae bibendum velit fringilla vitae!
|
||||
Lorem ipsum dolor sit amet, consectetur adipiscing elit.
|
||||
Mauris eget leo nunc, nec tempus mi? Curabitur id nisl mi, ut vulputate urna.
|
||||
Quisque porta facilisis tortor, vitae bibendum velit fringilla vitae!
|
||||
____
|
||||
|
||||
Lorem ipsum dolor sit amet, consectetur adipiscing elit.
|
||||
|
||||
[verse]
|
||||
____
|
||||
The fog comes
|
||||
on little cat feet.
|
||||
____
|
||||
|
||||
== Fin
|
||||
|
||||
That's all, folks!
|
|
@ -0,0 +1,44 @@
|
|||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 40 30">
|
||||
<defs>
|
||||
<filter id="b" width="1.041" height="1.058" x="-.021" y="-.029" color-interpolation-filters="sRGB">
|
||||
<feGaussianBlur stdDeviation=".172"/>
|
||||
</filter>
|
||||
<filter id="a" width="1.021" height="1.029" x="-.01" y="-.014" color-interpolation-filters="sRGB">
|
||||
<feGaussianBlur stdDeviation=".086"/>
|
||||
</filter>
|
||||
</defs>
|
||||
<rect width="20.063" height="14.331" x="9.968" y="14.969" fill="#3d3d3d" filter="url(#a)" rx="1.66" ry="1.66"/>
|
||||
<path fill="#ff6f00" stroke-width="1.113" d="M27.364 4.53a3.8 3.8 0 0 0-1.201 7.406c.19.035.26-.082.26-.183l-.006-.707c-1.057.23-1.28-.449-1.28-.449-.173-.439-.422-.556-.422-.556-.345-.236.026-.23.026-.23.382.026.583.39.583.39.338.582.889.414 1.105.317.035-.246.133-.413.242-.508-.844-.096-1.732-.422-1.732-1.878 0-.415.149-.754.392-1.02-.04-.096-.17-.483.037-1.006 0 0 .319-.102 1.045.39.303-.085.628-.127.951-.128.323.001.648.043.952.128.725-.492 1.044-.39 1.044-.39.207.523.077.91.037 1.006.244.266.391.605.391 1.02 0 1.46-.889 1.78-1.735 1.875.137.118.258.349.258.703 0 .509-.004.918-.004 1.043 0 .101.068.22.26.183a3.8 3.8 0 0 0-1.203-7.406zm-2.377 5.413c-.008.02-.038.025-.065.012-.027-.013-.043-.038-.034-.057.008-.02.038-.025.065-.012.028.012.044.038.034.057zm.187.167c-.018.017-.053.01-.077-.017-.025-.027-.03-.062-.012-.08.02-.016.053-.008.078.018.025.027.03.062.011.08zm.128.213c-.023.017-.061.002-.085-.032-.023-.034-.023-.075.001-.09.024-.017.061-.002.085.031.023.034.023.075 0 .091zm.217.248c-.02.023-.065.016-.097-.015-.034-.03-.043-.074-.022-.097.021-.023.066-.017.098.015.033.03.043.074.021.097zm.28.083c-.009.03-.051.043-.094.03-.043-.012-.072-.047-.063-.077.01-.03.052-.044.095-.03.043.012.071.047.063.077zm.32.035c0 .032-.036.058-.081.058-.046.001-.082-.024-.083-.055 0-.031.036-.057.081-.058.046 0 .083.024.083.055zm.313-.012c.005.031-.026.062-.071.07-.044.009-.085-.01-.09-.04-.006-.032.026-.063.07-.071.045-.008.085.01.09.041z"/>
|
||||
<path fill="#ff6f00" stroke-width=".902" d="M23.85 3.643L20.355.151a.515.515 0 0 0-.728 0l-.726.725.92.92a.612.612 0 0 1 .775.78l.887.887a.612.612 0 1 1-.367.345l-.827-.827v2.177a.613.613 0 1 1-.504-.018V2.943a.613.613 0 0 1-.333-.804l-.907-.907-2.395 2.395a.515.515 0 0 0 0 .729l3.493 3.493a.515.515 0 0 0 .728 0l3.477-3.477a.516.516 0 0 0 0-.729"/>
|
||||
<g fill-rule="evenodd">
|
||||
<path fill="#fc6d26" d="M16.363 7.948l-.425-1.309-.843-2.594a.145.145 0 0 0-.275 0l-.843 2.594h-2.799l-.843-2.594a.145.145 0 0 0-.275 0l-.843 2.594-.425 1.309a.29.29 0 0 0 .105.324l3.68 2.674 3.68-2.674a.29.29 0 0 0 .106-.324"/>
|
||||
<path fill="#c43e00" d="M12.577 10.942l1.4-4.307h-2.8z"/>
|
||||
<path fill="#ff6f00" d="M12.577 10.942l-1.399-4.307H9.217z"/>
|
||||
<path fill="#ffa040" d="M9.217 6.631L8.792 7.94a.29.29 0 0 0 .105.324l3.68 2.674z"/>
|
||||
<path fill="#c43e00" d="M9.217 6.632h1.961l-.843-2.594a.145.145 0 0 0-.275 0z"/>
|
||||
<path fill="#ff6f00" d="M12.578 10.942l1.4-4.307h1.96z"/>
|
||||
<path fill="#ffa040" d="M15.938 6.631l.426 1.309a.29.29 0 0 1-.106.324l-3.68 2.674z"/>
|
||||
<path fill="#c43e00" d="M15.938 6.632h-1.961l.843-2.594a.145.145 0 0 1 .275 0z"/>
|
||||
</g>
|
||||
<g fill="none" stroke="#ff6f00" stroke-linecap="round" stroke-linejoin="round" stroke-width=".38">
|
||||
<path d="M27.364 12.94v3.1M20 9v8.1M12.578 11.94v4.1"/>
|
||||
</g>
|
||||
<rect width="20.063" height="14.331" x="9.968" y="14.969" fill="#505050" rx="1.66" ry="1.66"/>
|
||||
<rect width="20.063" height="14.331" x="9.968" y="14.969" fill="#484848" fill-opacity=".953" filter="url(#b)" rx="1.66" ry="1.66"/>
|
||||
<rect width="18.339" height="12.762" x="10.83" y="15.754" fill="#3d3d3d" rx=".42" ry=".42"/>
|
||||
<path fill="none" stroke="#ff6f00" stroke-linecap="round" stroke-linejoin="round" stroke-width=".24" d="M18.222 17.496h-6.35"/>
|
||||
<rect width="7.365" height="5.758" x="20.885" y="16.897" fill="#a1a1a1" rx=".4" ry=".4"/>
|
||||
<path fill="#ff6f00" d="M25.399 18.297c.367 0 2.242 3.657 2.058 3.975-.183.318-5.797.318-5.98 0-.184-.318 3.555-3.975 3.922-3.975z"/>
|
||||
<g fill="none" stroke="#ff6f00" stroke-linecap="round" stroke-linejoin="round" stroke-width=".24">
|
||||
<path d="M17.163 19.437h-5.292M17.163 20.437h-5.292M15.047 21.437h-3.175"/>
|
||||
</g>
|
||||
<path fill="#a1a1a1" d="M11.848 25.486a.099.099 0 0 0-.098.1v2.929h.183V25.68c0-.014.012-.025.025-.025h16.083c.014 0 .025.011.025.025v2.834h.183v-2.928c0-.056-.043-.1-.097-.1z"/>
|
||||
<path fill="#505050" d="M11.958 25.656a.025.025 0 0 0-.025.025v2.839h16.133V25.68a.025.025 0 0 0-.024-.025z"/>
|
||||
<g fill="none" stroke="#ff6f00" stroke-linecap="round" stroke-linejoin="round">
|
||||
<g stroke-width=".2">
|
||||
<path d="M15.124 26.486h-2.117M17.77 26.486h-1.587M16.912 28.074h-2.117M15.653 27.245h-1.587"/>
|
||||
</g>
|
||||
<path stroke-width=".24" d="M17.163 24.671h-5.292"/>
|
||||
<path stroke-width=".2" d="M20.416 26.486h-1.587"/>
|
||||
</g>
|
||||
</svg>
|
After Width: | Height: | Size: 4.6 KiB |
|
@ -0,0 +1,126 @@
|
|||
antoraVersion: '1.0.0'
|
||||
site:
|
||||
url: http://localhost:5252
|
||||
title: Brand Docs
|
||||
homeUrl: &home_url /xyz/5.2/index.html
|
||||
components:
|
||||
- name: abc
|
||||
title: Project ABC
|
||||
url: '#'
|
||||
versions:
|
||||
- &latest_version_abc
|
||||
url: '#'
|
||||
version: '1.1'
|
||||
displayVersion: '1.1'
|
||||
- url: '#'
|
||||
version: '1.0'
|
||||
displayVersion: '1.0'
|
||||
latestVersion: *latest_version_abc
|
||||
- &component
|
||||
name: xyz
|
||||
title: &component_title Project XYZ
|
||||
url: /xyz/6.0/index.html
|
||||
versions:
|
||||
- &latest_version_xyz
|
||||
url: /xyz/6.0/index.html
|
||||
version: '6.0'
|
||||
displayVersion: '6.0'
|
||||
- &component_version
|
||||
title: *component_title
|
||||
url: '#'
|
||||
version: '5.2'
|
||||
displayVersion: '5.2'
|
||||
- url: '#'
|
||||
version: '5.1'
|
||||
displayVersion: '5.1'
|
||||
- url: '#'
|
||||
version: '5.0'
|
||||
displayVersion: '5.0'
|
||||
latestVersion: *latest_version_xyz
|
||||
- name: '123'
|
||||
title: Project 123
|
||||
url: '#'
|
||||
versions:
|
||||
- &latest_version_123
|
||||
url: '#'
|
||||
version: '2.2'
|
||||
displayVersion: '2.2'
|
||||
- url: '#'
|
||||
version: '2.1'
|
||||
displayVersion: '2.1'
|
||||
- url: '#'
|
||||
version: '2.0'
|
||||
displayVersion: '2.0'
|
||||
latestVersion: *latest_version_123
|
||||
page:
|
||||
url: *home_url
|
||||
home: true
|
||||
title: Brand’s Hardware & Software Requirements
|
||||
component: *component
|
||||
componentVersion: *component_version
|
||||
version: '5.2'
|
||||
displayVersion: '5.2'
|
||||
module: ROOT
|
||||
relativeSrcPath: index.adoc
|
||||
editUrl: http://example.com/project-xyz/blob/main/index.adoc
|
||||
origin:
|
||||
private: false
|
||||
previous:
|
||||
content: Quickstart
|
||||
url: '#'
|
||||
urlType: 'internal'
|
||||
next:
|
||||
content: Liber Recusabo
|
||||
url: '#'
|
||||
urlType: 'internal'
|
||||
breadcrumbs:
|
||||
- content: Quickstart
|
||||
url: '#'
|
||||
urlType: fragment
|
||||
- content: Brand’s Hardware & Software Requirements
|
||||
url: /xyz/5.2/index.html
|
||||
urlType: internal
|
||||
versions:
|
||||
- version: '6.0'
|
||||
displayVersion: '6.0'
|
||||
url: '#'
|
||||
- version: '5.2'
|
||||
displayVersion: '5.2'
|
||||
url: '#'
|
||||
- version: '5.1'
|
||||
displayVersion: '5.1'
|
||||
url: '#'
|
||||
- version: '5.0'
|
||||
displayVersion: '5.0'
|
||||
missing: true
|
||||
url: '#'
|
||||
navigation:
|
||||
- root: true
|
||||
items:
|
||||
- content: Quickstart
|
||||
url: '#'
|
||||
urlType: fragment
|
||||
items:
|
||||
- content: Brand’s Hardware & Software Requirements
|
||||
url: /xyz/5.2/index.html
|
||||
urlType: internal
|
||||
- content: Cu Solet
|
||||
url: '/xyz/5.2/index.html#cu-solet'
|
||||
urlType: internal
|
||||
- content: English + 中文
|
||||
url: '/xyz/5.2/index.html#english+中文'
|
||||
urlType: internal
|
||||
- content: Liber Recusabo
|
||||
url: '#liber-recusabo'
|
||||
urlType: fragment
|
||||
- content: Reference
|
||||
items:
|
||||
- content: Keyboard Shortcuts
|
||||
url: '#'
|
||||
urlType: fragment
|
||||
- content: Importing and Exporting
|
||||
url: '#'
|
||||
urlType: fragment
|
||||
- content: Some Code
|
||||
url: '/xyz/5.2/index.html#some-code'
|
||||
urlType: internal
|
|
@ -0,0 +1,23 @@
|
|||
{
|
||||
"compilerOptions": {
|
||||
"target": "ES6",
|
||||
"useDefineForClassFields": true,
|
||||
"module": "ESNext",
|
||||
"skipLibCheck": true,
|
||||
"moduleResolution": "bundler",
|
||||
"allowImportingTsExtensions": true,
|
||||
"resolveJsonModule": true,
|
||||
"isolatedModules": true,
|
||||
"noEmit": true,
|
||||
"strict": true,
|
||||
"noUnusedLocals": true,
|
||||
"noUnusedParameters": true,
|
||||
"noFallthroughCasesInSwitch": true
|
||||
},
|
||||
"include": [
|
||||
"src/js/*.ts"
|
||||
],
|
||||
"exclude": [
|
||||
"node_modules"
|
||||
]
|
||||
}
|
|
@ -0,0 +1,3 @@
|
|||
import { defineConfig } from 'vite';
|
||||
|
||||
export default defineConfig({});
|
Loading…
Reference in New Issue