Skip to content

Commit

Permalink
Add initial website structure
Browse files Browse the repository at this point in the history
- Use https://github.com/aaranxu/adidoks theme by including a Git
  submodule. Remove the temporary hallo theme. Modify the config.toml
  according to the provided example.
- Add home page, installation guide, contribution guides, FAQs,
  and authors.
- Add favicons generated from the SVG icon with
  https://realfavicongenerator.net.
  • Loading branch information
leejuyuu committed Feb 12, 2024
1 parent 3eef4f2 commit f557de0
Show file tree
Hide file tree
Showing 66 changed files with 692 additions and 9,382 deletions.
3 changes: 3 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[submodule "themes/adidoks"]
path = themes/adidoks
url = https://github.com/aaranxu/adidoks.git
119 changes: 103 additions & 16 deletions config.toml
Original file line number Diff line number Diff line change
@@ -1,9 +1,14 @@
# The URL the site will be built for
base_url = "https://nomacs.org"
title = "nomacs - Image Lounge"
title = "nomacs"
description = "nomacs is a free, open source image viewer, which supports multiple platforms"

theme = "hallo"
# The site theme to use.
theme = "adidoks"

# The default language; used in feeds and search index
# Note: the search index doesn't support Chinese/Japanese/Korean Languages
default_language = "en"

# Whether to automatically compile all Sass files in the sass directory
compile_sass = true
Expand All @@ -14,7 +19,14 @@ generate_feed = true
# When set to "true", the generated HTML files are minified.
minify_html = false

# The taxonomies to be rendered for the site and their configuration.
taxonomies = [
{name = "authors"}, # Basic definition: no feed or pagination
]

# Whether to build a search index to be used later on by a JavaScript library
# When set to "true", a search index is built from the pages and section
# content for `default_language`.
build_search_index = true

[search]
Expand All @@ -26,22 +38,97 @@ include_description = false
include_content = true

[markdown]
# Whether to do syntax highlighting
# Theme can be customised by setting the `highlight_theme` variable to a theme supported by Zola
# Whether to do syntax highlighting.
# Theme can be customised by setting the `highlight_theme`
# variable to a theme supported by Zola
highlight_code = true
highlight_theme = "dracula"

[extra]
# Put all your custom variables here
greeting = "nomacs - Image Lounge"
message = "We are in process of migrating our website. For the time being, please visit our GitHub page."
authorname = "nomacs maintainers"
links = [
{ title = "E-Mail", url = "mailto:[email protected]", iconset = "fas", icon = "envelope" },
{ title = "GitHub", url = "https://github.com/nomacs/nomacs", icon = "github" },
]
author = "Nomacs maintainers"
github = "https://github.com/nomacs/nomacs"

# If running on netlify.app site, set to true
is_netlify = false

# Set HTML file language
language_code = "en-US"

# Set theme-color meta tag for Chrome browser
theme_color = "#fff"

# More about site's title
title_separator = "|" # set as |, -, _, etc
title_addition = "Image Lounge"


# Set date format in blog publish metadata
timeformat = "%B %e, %Y" # e.g. June 14, 2021
timezone = "America/New_York"

# Edit page on reposity or not
edit_page = false
docs_repo = "https://github.com/nomacs/nomacs.github.io"
repo_branch = "main"

## Math settings
# options: true, false. Enable math support globally,
# default: false. You can always enable math on a per page.
math = false
library = "katex" # options: "katex", "mathjax". default is "katex".

## Open Graph + Twitter Cards
[extra.open]
enable = true
# this image will be used as fallback if a page has no image of its own
image = "nomacs.svg"
twitter_site = "nomacs"
twitter_creator = "nomacs"
facebook_author = "nomacs"
facebook_publisher = "nomacs"
og_locale = "en_US"

## JSON-LD
[extra.schema]
type = "Organization"
logo = "nomacs.svg"
github = "https://github.com/nomacs/nomacs"
section = "blog" # see config.extra.main~url
## Sitelinks Search Box
site_links_search_box = false


# Menu items
[[extra.menu.main]]
name = "Docs"
section = "docs"
url = "/docs/getting-started/introduction/"
weight = 10

[[extra.menu.main]]
name = "Blog"
section = "blog"
url = "/blog/"
weight = 20

[[extra.menu.social]]
name = "Matrix"
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-message-circle"><path d="M21 11.5a8.38 8.38 0 0 1-.9 3.8 8.5 8.5 0 0 1-7.6 4.7 8.38 8.38 0 0 1-3.8-.9L3 21l1.9-5.7a8.38 8.38 0 0 1-.9-3.8 8.5 8.5 0 0 1 4.7-7.6 8.38 8.38 0 0 1 3.8-.9h.5a8.48 8.48 0 0 1 8 8v.5z"></path></svg>'
url = "https://matrix.to/#/#nomacs:matrix.org"
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/nomacs/nomacs"
post = "v0.1.0"
weight = 20

# Footer contents
[extra.footer]
info = 'Powered by <a href="https://www.getzola.org/">Zola</a> and <a href="https://github.com/aaranxu/adidoks">AdiDoks</a>'

[extra.theme]
background = "#f7fade" #"#0b93c0" #"#6FCDBD"
foreground = "#0b93c0" #"#f1f4d8" #"#FFF" # text and portrait border
hover = "#a2ac85" #"#333" # link hover
[[extra.footer.nav]]
name = "Code of Conduct"
url = "/docs/contributing/code-of-conduct/"
weight = 20
39 changes: 39 additions & 0 deletions content/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
+++
title = "nomacs - Image Lounge"


# The homepage contents
[extra]
lead = 'nomacs is a free, open source image viewer, which supports multiple platforms. You can use it for viewing all common image formats including RAW and psd images.'
url = "/docs/getting-started/introduction/"
url_button = "Get started"
repo_version = "GitHub v3.16"
repo_license = "GNU General Public License v3.0."
repo_url = "https://github.com/nomacs/nomacs"

# Menu items
[[extra.menu.main]]
name = "Docs"
section = "docs"
url = "/docs/getting-started/introduction/"
weight = 10

[[extra.menu.main]]
name = "Blog"
section = "blog"
url = "/blog/"
weight = 20

[[extra.list]]
title = "Image viewing"
content = 'Supports the most common image formats including RAW.'

[[extra.list]]
title = "Image editing"
content = 'Supports cropping, resizing, rotating, and color adjustments, and more.'

[[extra.list]]
title = "Viewer synchronization"
content = "The same action (like panning, zooming, etc.) can be performed on multiple viewers, making comparing two images easy."

+++
19 changes: 19 additions & 0 deletions content/authors/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
+++
title = "Authors"
description = "The authurs of the blog articles."
date = 2021-04-01T08:00:00+00:00
updated = 2021-04-01T08:00:00+00:00
draft = false

# If add a new author page in this section, please add a new item,
# and the format is as follows:
#
# "author-name-in-url" = "the-full-path-of-the-author-page"
#
# Note: We use quoted keys here.
[extra.author_pages]
"markus-diem" = "authors/markus-diem.md"
"stefan-fiel" = "authors/stefan-fiel.md"
+++

The authors of the blog articles.
11 changes: 11 additions & 0 deletions content/authors/markus-diem.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
+++
title = "Markus Diem"
description = "Creator of nomacs."
date = 2024-02-12T16:50:46Z
updated = 2024-02-12T16:50:46Z
draft = false
+++

Creator of **nomacs**.

[@diemmarkus](https://github.com/diemmarkus)
11 changes: 11 additions & 0 deletions content/authors/stefan-fiel.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
+++
title = "Stefan Fiel"
description = "Creator of nomacs."
date = 2024-02-12T17:05:37Z
updated = 2024-02-12T17:05:37Z
draft = false
+++

Creator of **nomacs**.

[@sfiel](https://github.com/sfiel)
9 changes: 9 additions & 0 deletions content/docs/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
+++
title = "Docs"
description = "The documents of nomacs."
date = 2024-02-12T18:21:28Z
updated = 2024-02-12T18:21:28Z
sort_by = "weight"
weight = 1
template = "docs/section.html"
+++
10 changes: 10 additions & 0 deletions content/docs/contributing/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
+++
title = "Contributing"
description = "Find out how to contribute to nomacs."
date = 2024-02-12T18:22:19Z
updated = 2024-02-12T18:22:19Z
template = "docs/section.html"
sort_by = "weight"
weight = 4
draft = false
+++
61 changes: 61 additions & 0 deletions content/docs/contributing/code-of-conduct.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
+++
title = "Code of Conduct"
description = "Contributor Covenant Code of Conduct."
date = 2024-02-03T09:08:13Z
updated = 2024-02-03T09:08:13Z
draft = false
weight = 420
sort_by = "weight"
template = "docs/page.html"

[extra]
lead = "Contributor Covenant Code of Conduct."
toc = true
top = false
+++


## Our Pledge

In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.

## Our Standards

Examples of behavior that contributes to creating a positive environment include:

* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

* The use of sexualized language or imagery and unwelcome sexual attention or advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a professional setting

## Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.

## Scope

This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at <https://matrix.to/#/#nomacs:matrix.org>. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]

[homepage]: http://contributor-covenant.org
[version]: http://contributor-covenant.org/version/1/4/
Loading

0 comments on commit f557de0

Please sign in to comment.