diff --git a/docs/config.toml b/docs/config.toml index a395048..246bb86 100644 --- a/docs/config.toml +++ b/docs/config.toml @@ -1,7 +1,7 @@ # The URL the site will be built for -base_url = "https://adidoks.netlify.com" -title = "AdiDoks" -description = "AdiDoks is a Zola theme helping you build modern documentation websites, which is a port of the Hugo theme Doks for Zola." +base_url = "https://doubleailes.github.io/fls/" +title = "fls" +description = "fls is simple command lien tool" # The site theme to use. theme = "adidoks" @@ -45,10 +45,9 @@ highlight_code = true [extra] # Put all your custom variables here -author = "Aaran Xu" -github = "https://github.com/aaranxu" -twitter = "https://twitter.com/aaranxu" -email = "aaranxu@outlook.com" +author = "Philippe Llerena" +github = "https://github.com/doubleailes" +twitter = "https://twitter.com/doubleailes" # If running on netlify.app site, set to true is_netlify = true @@ -70,7 +69,7 @@ timezone = "America/New_York" # Edit page on reposity or not edit_page = false -docs_repo = "https://github.com/aaranxu/adidoks" +docs_repo = "https://github.com/doubleailes/fls" repo_branch = "main" ## Math settings @@ -94,9 +93,9 @@ og_locale = "en_US" [extra.schema] type = "Organization" logo = "logo-doks.png" -twitter = "https://twitter.com/aaranxu" +twitter = "https://twitter.com/doubleailes" linked_in = "" -github = "https://github.com/aaranxu" +github = "https://github.com/doubleailes" section = "blog" # see config.extra.main~url ## Sitelinks Search Box site_links_search_box = false @@ -118,13 +117,13 @@ weight = 20 [[extra.menu.social]] name = "Twitter" pre = '' -url = "https://twitter.com/aaranxu" +url = "https://twitter.com/doubleailes" weight = 10 [[extra.menu.social]] name = "GitHub" pre = '' -url = "https://github.com/aaranxu/adidoks" +url = "https://github.com/doubleailes/fls" post = "v0.1.0" weight = 20 diff --git a/docs/content/_index.fi.md b/docs/content/_index.fi.md deleted file mode 100644 index 0e52f3c..0000000 --- a/docs/content/_index.fi.md +++ /dev/null @@ -1,51 +0,0 @@ -+++ -title = "Nykyaikainen teema dokumentaatiolle" - - -# The homepage contents -[extra] -lead = 'AdiDoks on nykyaikainen teema dokumentaatiosivustoille. Se on portattu Zolalle Hugo-teemasta nimeltä Doks.' -url = "/docs/getting-started/introduction/" -url_button = "Aloita" -repo_version = "GitHub v0.1.0" -repo_license = "Open-source MIT License." -repo_url = "https://github.com/aaranxu/adidoks" - -# Menu items -[[extra.menu.main]] -name = "Dokumentaatio" -section = "docs" -url = "/docs/getting-started/introduction/" -weight = 10 - -[[extra.menu.main]] -name = "Blogi" -section = "blog" -url = "/blog/" -weight = 20 - -[[extra.list]] -title = "Turvallisuustietoinen" -content = 'Saat A+-arvosanoja Mozilla Observatoryssä suoraan. Voit vaihtaa turvallisuusheadereita tarpeidesi mukaan.' - -[[extra.list]] -title = "Salamannopea ⚡️" -content = 'Saat hyvät pisteet Google Lighthousessa defaultina. Doks poistaa tarpeettomat css:t, esinoutaa linkit, ja lataa kuvat laiskasti.' - -[[extra.list]] -title = "SEO-valmis" -content = "Käytä järkeviä oletusarvoja rakenteiselle datalle, open graphille ja Twitter-korteille. Tai muunna SEO-asetukset mieleisiksesi helposti." - -[[extra.list]] -title = "Fulltext-haku" -content = "Tee hakuja sivuillesi FlexSearchilla. Muuntele indeksointiasetuksia mieleisiksesi helposti." - -[[extra.list]] -title = "Sivujen layoutit" -content = "Rakenna sivuja laskeutumisivun, blogisivun tai dokumentaatiolayoutin mukaan. Lisää osioita ja komponentteja tarpeen mukaan." - -[[extra.list]] -title = "Dark mode" -content = "Vaihda hämärässä käytettävään käyttöliittymäteemaan nappia painamalla. Muuta värit muuttujilla vastaamaan brändiäsi." - -+++ diff --git a/docs/content/_index.md b/docs/content/_index.md index fb5961e..eefb6c1 100644 --- a/docs/content/_index.md +++ b/docs/content/_index.md @@ -1,15 +1,15 @@ +++ -title = "Modern Documentation Theme" +title = "A simple but sexy ls command line tool" # The homepage contents [extra] -lead = 'AdiDoks is a modern documentation theme, which is a port of the Hugo theme Doks for Zola.' +lead = 'fls is a command line tool dedicated to animation and vfx terminal user.' url = "/docs/getting-started/introduction/" url_button = "Get started" -repo_version = "GitHub v0.1.0" +repo_version = "GitHub v0.4.0rc.5" repo_license = "Open-source MIT License." -repo_url = "https://github.com/aaranxu/adidoks" +repo_url = "https://github.com/doubleailes/fls" # Menu items [[extra.menu.main]] @@ -18,34 +18,12 @@ section = "docs" url = "/docs/getting-started/introduction/" weight = 10 -[[extra.menu.main]] -name = "Blog" -section = "blog" -url = "/blog/" -weight = 20 - -[[extra.list]] -title = "Security aware" -content = 'Get A+ scores on Mozilla Observatory out of the box. Easily change the default Security Headers to suit your needs.' - -[[extra.list]] -title = "Fast by default ⚡️" -content = 'Get 100 scores on Google Lighthouse by default. Doks removes unused css, prefetches links, and lazy loads images.' - -[[extra.list]] -title = "SEO-ready" -content = "Use sensible defaults for structured data, open graph, and Twitter cards. Or easily change the SEO settings to your liking." - -[[extra.list]] -title = "Full text search" -content = "Search your Doks site with FlexSearch. Easily customize index settings and search options to your liking." - [[extra.list]] -title = "Page layouts" -content = "Build pages with a landing page, blog, or documentation layout. Add custom sections and components to suit your needs." +title = "Inspiration" +content = 'Inspire by the standard industry rvls command line from Autodesk© (♥ Tweak team)' [[extra.list]] -title = "Dark mode" -content = "Switch to a low-light UI with the click of a button. Change colors with variables to match your branding." +title = "Fast" +content = 'fls is made to be really fast. 5x time faster than any others' +++ diff --git a/docs/content/blog/_index.md b/docs/content/blog/_index.md deleted file mode 100644 index 95ecd8e..0000000 --- a/docs/content/blog/_index.md +++ /dev/null @@ -1,7 +0,0 @@ -+++ -title = "Blog" -description = "Blog" -sort_by = "date" -paginate_by = 2 -template = "blog/section.html" -+++ diff --git a/docs/content/blog/hello-world.md b/docs/content/blog/hello-world.md deleted file mode 100644 index 541c613..0000000 --- a/docs/content/blog/hello-world.md +++ /dev/null @@ -1,41 +0,0 @@ -+++ -title = "Hello World" -description = "Introducing Doks, a Hugo theme helping you build modern documentation websites that are secure, fast, and SEO-ready — by default." -date = 2021-05-01T09:19:42+00:00 -updated = 2021-05-01T09:19:42+00:00 -draft = false -template = "blog/page.html" - -[taxonomies] -authors = ["Rustaceans"] - -[extra] -lead = "This is the source code of the traditional Hello World program." -+++ - -```rust -// This is a comment, and is ignored by the compiler - -// This is the main function -fn main() { - // Statements here are executed when the compiled binary is called - - // Print text to the console - println!("Hello World!"); -} -``` - -`println!` is a macro that prints text to the console. - -A binary can be generated using the Rust compiler: `rustc`. - -```bash -$ rustc hello.rs -``` - -`rustc` will produce a `hello` binary that can be executed. - -```bash -$ ./hello -Hello World! -``` diff --git a/docs/content/blog/markdown-syntax.md b/docs/content/blog/markdown-syntax.md deleted file mode 100644 index baccf97..0000000 --- a/docs/content/blog/markdown-syntax.md +++ /dev/null @@ -1,152 +0,0 @@ -+++ -title = "Markdown Syntax Guide" -description = "Sample article showcasing basic Markdown syntax and formatting for HTML elements." -date = 2021-04-20T09:19:42+00:00 -updated = 2021-04-20T09:19:42+00:00 -draft = false -template = "blog/page.html" - -[taxonomies] -authors = ["Public"] - -[extra] -lead = "This article offers a sample of basic Markdown syntax that can be used in Zola content files, also it shows whether basic HTML elements are decorated with CSS in a Zola theme." -+++ - -## Headings - -The following HTML `

`—`

` elements represent six levels of section -headings. `

` is the highest section level while `

` is the lowest. - -# H1 -## H2 -### H3 -#### H4 -##### H5 -###### H6 - -## Paragraph - -Xerum, quo qui aut unt expliquam qui dolut labo. Aque venitatiusda cum, -voluptionse latur sitiae dolessi aut parist aut dollo enim qui voluptate ma -dolestendit peritin re plis aut quas inctum laceat est volestemque commosa as -cus endigna tectur, offic to cor sequas etum rerum idem sintibus eiur? Quianimin -porecus evelectur, cum que nis nust voloribus ratem aut omnimi, sitatur? -Quiatem. Nam, omnis sum am facea corem alique molestrunt et eos evelece arcillit -ut aut eos eos nus, sin conecerem erum fuga. Ri oditatquam, ad quibus unda -veliamenimin cusam et facea ipsamus es exerum sitate dolores editium rerore -eost, temped molorro ratiae volorro te reribus dolorer sperchicium faceata -tiustia prat. - -Itatur? Quiatae cullecum rem ent aut odis in re eossequodi nonsequ idebis ne -sapicia is sinveli squiatum, core et que aut hariosam ex eat. - -## Blockquotes - -The blockquote element represents content that is quoted from another source, -optionally with a citation which must be within a `footer` or `cite` element, -and optionally with in-line changes such as annotations and abbreviations. - -#### Blockquote without attribution - -> Tiam, ad mint andaepu dandae nostion secatur sequo quae. -> **Note** that you can use *Markdown syntax* within a blockquote. - -#### Blockquote with attribution - -> Don't communicate by sharing memory, share memory by communicating.
-> — Rob Pike[^1] - -> All men by nature desire to know.
-> ― Aristotle[^2] - -## Tables - -Tables aren't part of the core Markdown spec, but Zola supports them -out-of-the-box. - - Name | Age ---------|------ - Bob | 27 - Alice | 23 - -#### Inline Markdown within tables - -| Italics | Bold | Code | -| -------- | -------- | ------ | -| *italics* | **bold** | `code` | - -## Code Blocks - -#### Code block with backticks - -```html - - - - - Example HTML5 Document - - -

Test

- - -``` - -#### Code block indented with four spaces - - - - - - Example HTML5 Document - - -

Test

- - - -## List Types - -#### Ordered List - -1. First item -2. Second item -3. Third item - -#### Unordered List - -- List item -- Another item -- And another item - -#### Nested list - -- Fruit - - Apple - - Orange - - Banana -- Dairy - - Milk - - Cheese - -## Other Elements — abbr, sub, sup, kbd, mark - -GIF is a bitmap image format. - -H2O - -Xn + Yn = Zn - -Press CTRL+ALT+Delete to end the -session. - -Most salamanders are nocturnal, and hunt for insects, worms, and -other small creatures. - ---- - -[^1]: The above quote is excerpted from Rob Pike's [talk](https://www.youtube.com/watch?v=PAAkCSZUG1c) -during Gopherfest, November 18, 2015. - -[^2]: The quote is the first sentence of Aristotle's [Metaphysics](http://classics.mit.edu/Aristotle/metaphysics.html). \ No newline at end of file diff --git a/docs/content/blog/math-typesetting.md b/docs/content/blog/math-typesetting.md deleted file mode 100644 index 99eaca8..0000000 --- a/docs/content/blog/math-typesetting.md +++ /dev/null @@ -1,48 +0,0 @@ -+++ -title = "Math Typesetting" -description = "Introducing Doks, a Hugo theme helping you build modern documentation websites that are secure, fast, and SEO-ready — by default." -date = 2021-04-08T09:19:42+00:00 -updated = 2021-04-08T09:19:42+00:00 -draft = false -template = "blog/page.html" - -[taxonomies] -authors = ["Public"] - -[extra] -lead = "Mathematical notation in a project can be enabled by using third party JavaScript libraries." -math = true -+++ - - -In this example we will be using [KaTeX](https://katex.org/) - -- Create a macro under `/template/macros/math.html` with a macro named `math`. -- Within this macro reference the [Auto-render Extension](https://katex.org/docs/autorender.html) or host these scripts locally. -- Import the macro in your templates like so: - -```bash -{% import 'macros/math.html' as macros %} -{% if page.extra.math or section.extra.math or config.extra.math %} -{{ macros::math() }} -{% endif %} -``` - -- To enable KaTex globally set the parameter `extra.math` to `true` in a project's configuration -- To enable KaTex on a per page basis include the parameter `extra.math = true` in content files - -**Note:** - -1. The MathJax library is the other optional choice, and you can set the parameter `extra.library` to `mathjax` in a project's configuration -2. Use the online reference of [Supported TeX Functions](https://katex.org/docs/supported.html) - -### Examples - -

-Inline math: \(\varphi = \dfrac{1+\sqrt5}{2}= 1.6180339887…\) -

- -Block math: -$$ - \varphi = 1+\frac{1} {1+\frac{1} {1+\frac{1} {1+\cdots} } } -$$ diff --git a/docs/content/blog/placeholder-text.md b/docs/content/blog/placeholder-text.md deleted file mode 100644 index 750d5ab..0000000 --- a/docs/content/blog/placeholder-text.md +++ /dev/null @@ -1,62 +0,0 @@ -+++ -title = "Placeholder Text" -description = "Lorem Ipsum Dolor Si Amet" -date = 2021-04-10T09:19:42+00:00 -updated = 2021-04-10T09:19:42+00:00 -draft = false -template = "blog/page.html" - -[taxonomies] -authors = ["Public"] - -+++ - -Lorem est tota propiore conpellat pectoribus de pectora summo. Redit -teque digerit hominumque toris verebor lumina non cervice subde tollit usus -habet Arctonque, furores quas nec ferunt. Quoque montibus nunc caluere tempus -inhospita parcite confusaque translucet patri vestro qui optatis lumine -cognoscere flos nubis! Fronde ipsamque patulos Dryopen deorum. - -1. Exierant elisi ambit vivere dedere -2. Duce pollice -3. Eris modo -4. Spargitque ferrea quos palude - -Rursus nulli murmur; hastile inridet ut ab gravi sententia! Nomine potitus -silentia flumen, sustinet placuit petis in dilapsa erat sunt. Atria tractus malis. - -1. Comas hunc haec pietate fetum procerum dixit -2. Post torum vates letum Tiresia -3. Flumen querellas -4. Arcanaque montibus omnes -5. Quidem et - -# Vagus elidunt - - - -[The Van de Graaf Canon](https://en.wikipedia.org/wiki/Canons_of_page_construction#Van_de_Graaf_canon) - -## Mane refeci capiebant unda mulcebat - -Victa caducifer, malo vulnere contra dicere aurato, ludit regale, voca! Retorsit -colit est profanae esse virescere furit nec; iaculi matertera et visa est, -viribus. Divesque creatis, tecta novat collumque vulnus est, parvas. -**Faces illo pepulere** tempus adest. Tendit flamma, ab opes virum sustinet, -sidus sequendo urbis. - -Iubar proles corpore raptos vero auctor imperium; sed et huic: manus caeli -Lelegas tu lux. Verbis obstitit intus oblectamina fixis linguisque ausus sperare -Echionides cornuaque tenent clausit possit. Omnia putatur. Praeteritae refert -ausus; ferebant e primus lora nutat, vici quae mea ipse. Et iter nil spectatae -vulnus haerentia iuste et exercebat, sui et. - -Eurytus Hector, materna ipsumque ut Politen, nec, nate, ignari, vernum cohaesit -sequitur. Vel **mitis temploque** vocatus, inque alis, *oculos nomen* non silvis -corpore coniunx ne displicet illa. Crescunt non unus, vidit visa quantum inmiti -flumina mortis facto sic: undique a alios vincula sunt iactata abdita! -Suspenderat ego fuit tendit: luna, ante urbem Propoetides **parte**. - - diff --git a/docs/content/blog/say-hello-to-zola-doks.md b/docs/content/blog/say-hello-to-zola-doks.md deleted file mode 100644 index 5599f4a..0000000 --- a/docs/content/blog/say-hello-to-zola-doks.md +++ /dev/null @@ -1,15 +0,0 @@ -+++ -title = "Say hello to AdiDoks 👋" -description = "Introducing AdiDoks, a Zola theme helping you build modern documentation websites, which is a port of the Hugo theme Doks for Zola." -date = 2021-04-03T07:00:00+00:00 -updated = 2021-04-03T07:00:00+00:00 -template = "blog/page.html" -draft = false - -[taxonomies] -authors = ["Aaran Xu"] - -[extra] -lead = 'Introducing AdiDoks, a Zola theme helping you build modern documentation websites, which is a port of the Hugo theme Doks for Zola.' -images = [] -+++ diff --git a/docs/content/docs/getting-started/_index.md b/docs/content/docs/getting-started/_index.md index 8b972db..1d372a2 100644 --- a/docs/content/docs/getting-started/_index.md +++ b/docs/content/docs/getting-started/_index.md @@ -1,6 +1,6 @@ +++ title = "Getting Started" -description = "Quick start and guides for installing the AdiDoks theme on your preferred operating system." +description = "Quick start of the fls usage" date = 2025-05-01T08:00:00+00:00 updated = 2021-05-01T08:00:00+00:00 template = "docs/section.html" diff --git a/docs/content/docs/getting-started/images/fls_demo.gif b/docs/content/docs/getting-started/images/fls_demo.gif new file mode 100644 index 0000000..fc3bc44 Binary files /dev/null and b/docs/content/docs/getting-started/images/fls_demo.gif differ diff --git a/docs/content/docs/getting-started/introduction.md b/docs/content/docs/getting-started/introduction.md index 6dfe20b..1a93f05 100644 --- a/docs/content/docs/getting-started/introduction.md +++ b/docs/content/docs/getting-started/introduction.md @@ -1,6 +1,6 @@ +++ title = "Introduction" -description = "AdiDoks is a Zola theme helping you build modern documentation websites, which is a port of the Hugo theme Doks for Zola." +description = "fls is a simple command line to pack frames sequence in a terminal way" date = 2021-05-01T08:00:00+00:00 updated = 2021-05-01T08:00:00+00:00 draft = false @@ -9,7 +9,7 @@ sort_by = "weight" template = "docs/page.html" [extra] -lead = 'AdiDoks is a Zola theme helping you build modern documentation websites, which is a port of the Hugo theme Doks for Zola.' +lead = 'fls is a simple command line to pack frames sequence in a terminal way' toc = true top = false +++ diff --git a/docs/content/docs/getting-started/quick-start.md b/docs/content/docs/getting-started/quick-start.md index db3a22d..c7d457c 100644 --- a/docs/content/docs/getting-started/quick-start.md +++ b/docs/content/docs/getting-started/quick-start.md @@ -1,6 +1,6 @@ +++ title = "Quick Start" -description = "One page summary of how to start a new AdiDoks project." +description = "How to start using fls?" date = 2021-05-01T08:20:00+00:00 updated = 2021-05-01T08:20:00+00:00 draft = false @@ -9,86 +9,56 @@ sort_by = "weight" template = "docs/page.html" [extra] -lead = "One page summary of how to start a new AdiDoks project." +lead = "How to start using fls?" toc = true top = false +++ ## Requirements -Before using the theme, you need to install the [Zola](https://www.getzola.org/documentation/getting-started/installation/) ≥ 0.15.0. +### Configuration -## Run the Theme Directly +a standard machine with an OS listed below: +- Windows 10 x86_64+ +- current linux distro tested: Fedora 37, Centos 7, Manjaro 22 +- MacOs 10.7+ -```bash -git clone https://github.com/aaranxu/adidoks.git -cd adidoks -zola serve -``` - -Visit `http://127.0.0.1:1111/` in the browser. +### Terminal +Before using `fls` you need to have the adminstrator right and terminal application +like **powershell** or **gnome-terminal** ## Installation -Just earlier we showed you how to run the theme directly. Now we start to -install the theme in an existing site step by step. - -### Step 1: Create a new zola site - -```bash -zola init mysite -``` - -### Step 2: Install AdiDoks - -Download this theme to your themes directory: - -```bash -cd mysite/themes -git clone https://github.com/aaranxu/adidoks.git -``` - -Or install as a submodule: +### Pre-compile bin -```bash -cd mysite -git init # if your project is a git repository already, ignore this command -git submodule add https://github.com/aaranxu/adidoks.git themes/adidoks -``` +You can download the last version -### Step 3: Configuration +#### Windows -Enable the theme in your `config.toml` in the site derectory: +- Unzip the folder +- Copy the `fls.exe` file into `C:\program files\Fls` +- Add the path `C:\program files\Fls` to the `PATH` environement variable -```toml -theme = "adidoks" -``` +#### Linux -Or copy the `config.toml.example` from the theme directory to your project's -root directory: +- Untar the folder +- Copy the `fls` binary into `/usr/bin` -```bash -cp themes/adidoks/config.toml.example config.toml -``` +### From Cargo -### Step 4: Add new content +You can install via [](https://crates.io/crates/framels) -You can copy the content from the theme directory to your project: +- Run `cargo install framels` +- Check `~/.cargo/bin/` is added to path if not add it -```bash -cp -r themes/adidoks/content . -``` +## Usage -You can modify or add new posts in the `content/blog`, `content/docs` or other -content directories as needed. +### Help -### Step 5: Run the project +Run `fls --help` -Just run `zola serve` in the root path of the project: +### Basic Listing -```bash -zola serve -``` +Run `fls` to list your current directory. -AdiDoks will start the Zola development web server accessible by default at -`http://127.0.0.1:1111`. Saved changes will live reload in the browser. +![](./docs/content/docs/getting-started/images/fls_demo.gif) \ No newline at end of file