Move docs in-repo
continuous-integration/drone/push Build is passing
Details
@ -0,0 +1,6 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<project version="4">
|
||||
<component name="VcsDirectoryMappings">
|
||||
<mapping directory="$PROJECT_DIR$" vcs="Git" />
|
||||
</component>
|
||||
</project>
|
@ -0,0 +1 @@
|
||||
www*
|
@ -0,0 +1,31 @@
|
||||
<center>
|
||||
<br>
|
||||
<img alt="The Extollo logo" src="https://static.garrettmills.dev/sites/extollo/docs/assets/logo/svg/Extollo-Icon-and-Text-LIGHT-Final.svg" height="150">
|
||||
<br><br>
|
||||
<b>extollo</b> - (v. <em>latin</em>) - to lift up, to elevate
|
||||
<br><br>
|
||||
Extollo is a <a href="https://www.gnu.org/philosophy/floss-and-foss.en.html" target="_blank">free & libre</a> application framework in TypeScript.
|
||||
</center>
|
||||
<hr>
|
||||
|
||||
Built on principles of modularity, strict-typing, inversion-of-control, and developer ergonomics, Extollo enables developers to build maintainable, scalable, and expressive applications.
|
||||
|
||||
Node.js provides an excellent platform for quickly getting an application up and running, but this loose minimalism can lead to larger, more unweildy code-bases as your application grows. Extollo fixes this by providing an opinionated, robust framework and first-party modules that provide, among other things:
|
||||
|
||||
- Type-based dependency injection
|
||||
- Strongly-typed ORM with an expressive query-builder and models
|
||||
- Customizable session & caching interfaces
|
||||
- Modular, pre-compiled, nest-able routes
|
||||
- First-party, extensible command line tools
|
||||
- Unit-based application structure
|
||||
|
||||
## Getting Started
|
||||
Writing an application with Extollo is very straightforward if you are familiar with Node.js/TypeScript, or similar frameworks like Laravel.
|
||||
|
||||
Check out the [Getting Started](https://extollo.garrettmills.dev/pages/Documentation/Getting-Started.html) page site for more information.
|
||||
|
||||
## License & Philosophy
|
||||
The Extollo project is, and will always be, free & libre software. The framework itself is open-source available [here](https://code.garrettmills.dev/Extollo), and is licensed under the terms of the MIT license. See the LICENSE file for more information.
|
||||
|
||||
## Contributing
|
||||
Have an improvement or fix to Extollo? Contributors are always welcome. See the CONTRIBUTING.md file for next steps.
|
@ -0,0 +1 @@
|
||||
# About the Extollo Project
|
@ -0,0 +1,7 @@
|
||||
# Getting Started with Extollo
|
||||
|
||||
## Requirements
|
||||
|
||||
- Node.js v14 or later
|
||||
- [PNPM](https://pnpm.js.org/) (not NPM/Yarn)
|
||||
- Postgres credentials (if you want to use [@extollo/orm](../modules/orm_src.html))
|
@ -0,0 +1,6 @@
|
||||
[
|
||||
{
|
||||
"pattern": "^",
|
||||
"replace": "https://code.garrettmills.dev/extollo/lib/src/branch/master/"
|
||||
}
|
||||
]
|
After Width: | Height: | Size: 206 KiB |
@ -0,0 +1,19 @@
|
||||
/* PROJECT */
|
||||
|
||||
Site Name: The Extollo Framework
|
||||
Site URL: https://extollo.garrettmills.dev/
|
||||
Created: 2021/03/24
|
||||
Standards: HTML5, CSS3
|
||||
Software: TypeDoc
|
||||
|
||||
/* AUTHOR */
|
||||
|
||||
Name: Garrett Mills
|
||||
Location: Lawrence, Kansas
|
||||
Site: https://garrettmills.dev/
|
||||
Blog: https://garrettmills.dev/blog/
|
||||
Contact: https://garrettmills.dev/#contact
|
||||
|
||||
/* THANKS */
|
||||
|
||||
To Piper Mills for the excellent font, color, and logo design.
|
@ -0,0 +1,64 @@
|
||||
h2 code {
|
||||
font-size: 1em;
|
||||
}
|
||||
|
||||
h3 code {
|
||||
font-size: 1em;
|
||||
}
|
||||
|
||||
.tsd-navigation.primary ul {
|
||||
border-bottom: none;
|
||||
}
|
||||
|
||||
.tsd-navigation.primary li {
|
||||
border-top: none;
|
||||
}
|
||||
|
||||
.tsd-navigation li.label.pp-nav.pp-group:first-child span {
|
||||
padding-top: 0;
|
||||
}
|
||||
|
||||
.tsd-navigation li.label.pp-nav.pp-group {
|
||||
font-weight: 700;
|
||||
border-bottom: 1px solid #eee;
|
||||
}
|
||||
|
||||
.tsd-navigation li.label.pp-nav.pp-group span {
|
||||
color: #222;
|
||||
}
|
||||
|
||||
.tsd-navigation li.pp-nav.pp-page.current {
|
||||
background-color: #f8f8f8;
|
||||
border-left: 2px solid #222;
|
||||
}
|
||||
|
||||
.tsd-navigation li.pp-nav.pp-page.current a {
|
||||
color: #222;
|
||||
}
|
||||
|
||||
.tsd-navigation li.pp-nav.pp-page.pp-parent.pp-active {
|
||||
border-left: 2px solid #eee;
|
||||
}
|
||||
|
||||
.tsd-navigation li.pp-nav.pp-page.pp-child {
|
||||
border-left: 2px solid #eee;
|
||||
padding-left: 15px;
|
||||
}
|
||||
|
||||
.tsd-navigation li.pp-nav.pp-page.pp-child.current {
|
||||
border-left: 2px solid #222;
|
||||
}
|
||||
|
||||
.tsd-kind-page .tsd-kind-icon:before {
|
||||
display: inline-block;
|
||||
vertical-align: middle;
|
||||
height: 16px;
|
||||
width: 16px;
|
||||
content: "";
|
||||
background-image: url("../images/page-icon.svg");
|
||||
background-size: 16px 16px;
|
||||
}
|
||||
|
||||
#tsd-search .results span.parent {
|
||||
color: #b3b2b2 !important;
|
||||
}
|
After Width: | Height: | Size: 9.4 KiB |
After Width: | Height: | Size: 28 KiB |
After Width: | Height: | Size: 468 B |
After Width: | Height: | Size: 480 B |
After Width: | Height: | Size: 855 B |
After Width: | Height: | Size: 9.3 KiB |
After Width: | Height: | Size: 11 KiB |
After Width: | Height: | Size: 11 KiB |
After Width: | Height: | Size: 4.8 KiB |
After Width: | Height: | Size: 4.6 KiB |
After Width: | Height: | Size: 691 B |
After Width: | Height: | Size: 2.2 KiB |
After Width: | Height: | Size: 2.2 KiB |
After Width: | Height: | Size: 1.7 KiB |
After Width: | Height: | Size: 1.6 KiB |
@ -0,0 +1,51 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>{{#ifCond model.name '==' project.name}}{{project.name}}{{else}}{{model.name}} | {{project.name}}{{/ifCond}}</title>
|
||||
<meta name="description" content="Documentation for {{project.name}}">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
|
||||
<link rel="stylesheet" href="{{relativeURL "assets/css/main.css"}}">
|
||||
<link rel="author" href="{{relativeURL "humans.txt"}}">
|
||||
<script async src="{{relativeURL "assets/js/search.js"}}" id="search-script"></script>
|
||||
</head>
|
||||
<body>
|
||||
|
||||
{{> header}}
|
||||
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
{{{contents}}}
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
{{#each navigation.children}}
|
||||
{{> navigation}}
|
||||
{{/each}}
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
{{#each toc.children}}
|
||||
{{> toc.root}}
|
||||
{{/each}}
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
{{> footer}}
|
||||
|
||||
<div class="overlay"></div>
|
||||
<script src="{{relativeURL "assets/js/main.js"}}"></script>
|
||||
|
||||
{{> analytics}}
|
||||
|
||||
</body>
|
||||
</html>
|
@ -0,0 +1,35 @@
|
||||
|
||||
<footer>
|
||||
<div class="container">
|
||||
<h2>Legend</h2>
|
||||
<div class="tsd-legend-group">
|
||||
{{#each legend}}
|
||||
<ul class="tsd-legend">
|
||||
{{#each .}}
|
||||
<li class="{{#compact}}{{#each classes}} {{.}}{{/each}}{{/compact}}"><span class="tsd-kind-icon">{{name}}</span></li>
|
||||
{{/each}}
|
||||
</ul>
|
||||
{{/each}}
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
|
||||
{{#unless settings.hideGenerator}}
|
||||
<div class="tsd-generator extollo-end-cap">
|
||||
<img src="{{relativeURL "assets/logo/svg/Extollo-Icon-and-Text-DARK-Final.svg"}}" style="max-height: 100px" class="svg-filter-white" alt="Extollo Logo">
|
||||
<p><b>extollo</b> (v. <em>latin</em>) - to lift up, to elevate</p>
|
||||
<p>
|
||||
Extollo is a <a href="https://www.gnu.org/philosophy/floss-and-foss.en.html" target="_blank">free & libre</a> application framework in TypeScript.
|
||||
</p>
|
||||
<p class="list-of-links">
|
||||
<ul>
|
||||
<li><a href="{{relativeURL "/"}}">Home</a></li>
|
||||
<li><a href="{{relativeURL "pages/Documentation/Getting-Started.html"}}">Getting Started</a></li>
|
||||
<li><a href="{{relativeURL "pages/Documentation/About-Extollo.html"}}">About Extollo</a></li>
|
||||
<li><a href="https://code.garrettmills.dev/Extollo" target="_blank">Source Code</a></li>
|
||||
<li><a href="https://code.garrettmills.dev/extollo/extollo/src/branch/master/CONTRIBUTING.md" target="_blank">Contributing</a></li>
|
||||
<li><a href="https://code.garrettmills.dev/Extollo/docs" target="_blank">Build These Docs</a></li>
|
||||
</ul>
|
||||
</p>
|
||||
</div>
|
||||
{{/unless}}
|
@ -0,0 +1,71 @@
|
||||
<header>
|
||||
<div class="tsd-page-toolbar">
|
||||
<div class="container">
|
||||
<div class="table-wrap">
|
||||
<div class="table-cell" id="tsd-search" data-index="{{relativeURL "assets/js/search.json"}}" data-base="{{relativeURL "./"}}">
|
||||
<div class="field">
|
||||
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
|
||||
<input id="tsd-search-field" type="text" />
|
||||
</div>
|
||||
|
||||
<ul class="results">
|
||||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
|
||||
<img src="{{relativeURL "assets/logo/svg/Extollo-Icon-NO-TEXT-light-and-dark-Final.svg"}}" alt="Extollo Icon" class="token-logo" style="max-height: 30px; margin-bottom: -10px; padding-right: 10px;">
|
||||
<a href="{{relativeURL "index.html"}}" class="title">{{project.name}}</a>
|
||||
</div>
|
||||
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<div id="tsd-filter">
|
||||
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
|
||||
<div class="tsd-filter-group">
|
||||
<div class="tsd-select" id="tsd-filter-visibility">
|
||||
<span class="tsd-select-label">All</span>
|
||||
<ul class="tsd-select-list">
|
||||
<li data-value="public">Public</li>
|
||||
<li data-value="protected">Public/Protected</li>
|
||||
<li data-value="private" class="selected">All</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<input type="checkbox" id="tsd-filter-inherited" checked />
|
||||
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
|
||||
|
||||
{{#unless settings.excludeExternals}}
|
||||
<input type="checkbox" id="tsd-filter-externals" checked />
|
||||
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
|
||||
{{/unless}}
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-page-title">
|
||||
<div class="container">
|
||||
{{#if model.parent}} {{! Don't show breadcrumbs on main project page, it is the root page. !}}
|
||||
<ul class="tsd-breadcrumb">
|
||||
{{#with model}}{{> breadcrumb}}{{/with}}
|
||||
</ul>
|
||||
{{/if}}
|
||||
<h1>{{#compact}}
|
||||
{{#ifCond model.kindString "!==" "Project" }}
|
||||
{{model.kindString}}
|
||||
{{/ifCond}}
|
||||
{{model.name}}
|
||||
{{#if model.typeParameters}}
|
||||
<
|
||||
{{#each model.typeParameters}}
|
||||
{{#if @index}}, {{/if}}
|
||||
{{name}}
|
||||
{{/each}}
|
||||
>
|
||||
{{/if}}
|
||||
{{/compact}}</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
@ -0,0 +1,3 @@
|
||||
<div class="tsd-panel tsd-typography">
|
||||
{{#markdown}}{{{model.pagesPlugin.item.contents}}}{{/markdown}}
|
||||
</div>
|
@ -0,0 +1,17 @@
|
||||
{
|
||||
"groups": [
|
||||
{
|
||||
"title": "Documentation",
|
||||
"pages": [
|
||||
{
|
||||
"title": "Getting Started",
|
||||
"source": "./docs/pages/Getting-Started.md"
|
||||
},
|
||||
{
|
||||
"title": "About Extollo",
|
||||
"source": "./docs/pages/About-Extollo.md"
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
@ -0,0 +1,11 @@
|
||||
{
|
||||
"name": "The Extollo Framework",
|
||||
"readme": "./docs/HOME.md",
|
||||
"tsconfig": "tsconfig.json",
|
||||
"sourcefile-url-map": "./docs/sourcefile-map.json",
|
||||
"theme": "./docs/theme",
|
||||
"out": "./docs/www",
|
||||
"entryPoints": [
|
||||
"src/index.ts"
|
||||
]
|
||||
}
|