Skip to content

Commit

Permalink
add a little bit of doc
Browse files Browse the repository at this point in the history
  • Loading branch information
doubleailes committed Jul 28, 2023
1 parent 132619f commit 7c7792d
Show file tree
Hide file tree
Showing 13 changed files with 51 additions and 480 deletions.
23 changes: 11 additions & 12 deletions docs/config.toml
Original file line number Diff line number Diff line change
@@ -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"
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -118,13 +117,13 @@ weight = 20
[[extra.menu.social]]
name = "Twitter"
pre = '<svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-twitter"><path d="M23 3a10.9 10.9 0 0 1-3.14 1.53 4.48 4.48 0 0 0-7.86 3v1A10.66 10.66 0 0 1 3 4s-4 9 5 13a11.64 11.64 0 0 1-7 2c9 5 20 0 20-11.5a4.5 4.5 0 0 0-.08-.83A7.72 7.72 0 0 0 23 3z"></path></svg>'
url = "https://twitter.com/aaranxu"
url = "https://twitter.com/doubleailes"
weight = 10

[[extra.menu.social]]
name = "GitHub"
pre = '<svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-github"><path d="M9 19c-5 1.5-5-2.5-7-3m14 6v-3.87a3.37 3.37 0 0 0-.94-2.61c3.14-.35 6.44-1.54 6.44-7A5.44 5.44 0 0 0 20 4.77 5.07 5.07 0 0 0 19.91 1S18.73.65 16 2.48a13.38 13.38 0 0 0-7 0C6.27.65 5.09 1 5.09 1A5.07 5.07 0 0 0 5 4.77a5.44 5.44 0 0 0-1.5 3.78c0 5.42 3.3 6.61 6.44 7A3.37 3.37 0 0 0 9 18.13V22"></path></svg>'
url = "https://github.com/aaranxu/adidoks"
url = "https://github.com/doubleailes/fls"
post = "v0.1.0"
weight = 20

Expand Down
51 changes: 0 additions & 51 deletions docs/content/_index.fi.md

This file was deleted.

38 changes: 8 additions & 30 deletions docs/content/_index.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
+++
title = "Modern Documentation Theme"
title = "A simple but sexy ls command line tool"


# The homepage contents
[extra]
lead = '<b>AdiDoks</b> is a modern documentation theme, which is a port of the Hugo theme <a href="https://github.com/h-enk/">Doks</a> for Zola.'
lead = '<b>fls</b> 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]]
Expand All @@ -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 <a href="https://observatory.mozilla.org/analyze/adidoks.org">Mozilla Observatory</a> 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 <a href="https://googlechrome.github.io/lighthouse/viewer/?gist=7731347bb8ce999eff7428a8e763b637">Google Lighthouse</a> 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 <b>rvls</b> 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 = '<b>fls</b> is made to be really fast. 5x time faster than any others'

+++
7 changes: 0 additions & 7 deletions docs/content/blog/_index.md

This file was deleted.

41 changes: 0 additions & 41 deletions docs/content/blog/hello-world.md

This file was deleted.

152 changes: 0 additions & 152 deletions docs/content/blog/markdown-syntax.md

This file was deleted.

Loading

0 comments on commit 7c7792d

Please sign in to comment.