Unverified Commit bcfce0b6 authored by Marco Blessing's avatar Marco Blessing Committed by GitHub
Browse files

Merge branch 'h-enk:master' into master

parents db8715e7 0cf93c9d
Loading
Loading
Loading
Loading

.github/FUNDING.yml

0 → 100644
+12 −0
Original line number Diff line number Diff line
# These are supported funding model platforms

github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
patreon: # Replace with a single Patreon username
open_collective: doks # Replace with a single Open Collective username
ko_fi: # Replace with a single Ko-fi username
tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
liberapay: # Replace with a single Liberapay username
issuehunt: # Replace with a single IssueHunt username
otechie: # Replace with a single Otechie username
custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']
+0 −1
Original line number Diff line number Diff line
bin
node_modules
public
resources
+27 −0
Original line number Diff line number Diff line
@@ -4,8 +4,35 @@ All notable changes to this project will be documented in this file. Dates are d

Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).

#### [v0.3.5](https://github.com/h-enk/doks/compare/v0.3.4...v0.3.5)

- feat: add versioning setup [`#478`](https://github.com/h-enk/doks/pull/478)
- feat: adjust latex svg image to dark theme [`#460`](https://github.com/h-enk/doks/pull/460)
- fix: edit-page multi-language support [`#459`](https://github.com/h-enk/doks/pull/459)
- feat: add docsRepoBranch config [`#458`](https://github.com/h-enk/doks/pull/458)
- feat: image max width [`#457`](https://github.com/h-enk/doks/pull/457)
- fix: docs url [`#456`](https://github.com/h-enk/doks/pull/456)
- chore(deps-dev): bump @babel/cli from 7.15.4 to 7.15.7 [`#463`](https://github.com/h-enk/doks/pull/463)
- feat: add multilingual support [`#454`](https://github.com/h-enk/doks/pull/454)
- deps: bump versions to latest [`94bacd3`](https://github.com/h-enk/doks/commit/94bacd3492e7b4d1e46aef13f86e5924ac645f4e)
- deps: bump @babel/cli from 7.15.4 to 7.15.7 [`130a13b`](https://github.com/h-enk/doks/commit/130a13bd9d3891d995e7373cc9a64fa527b4ce26)
- deps: bump versions to latest [`2503f5a`](https://github.com/h-enk/doks/commit/2503f5adf6d2650b82928a8770c2a1ccdc368a0c)

#### [v0.3.4](https://github.com/h-enk/doks/compare/v0.3.3...v0.3.4)

> 7 September 2021

- chore: update edit page default branch from master to main [`#426`](https://github.com/h-enk/doks/pull/426)
- Update index.js [`#417`](https://github.com/h-enk/doks/pull/417)
- Make id unique collapsible sidebar [`#378`](https://github.com/h-enk/doks/pull/378)
- deps: bump versions to latest [`8a98716`](https://github.com/h-enk/doks/commit/8a9871654e03b79082cfd9ebdf49a0a8ce7e21eb)
- deps: bump version to latest [`23d9dd7`](https://github.com/h-enk/doks/commit/23d9dd75c381b0440f4db717d63bea61baa0c584)
- deps: bump versions to latest [`700e566`](https://github.com/h-enk/doks/commit/700e56611d3a83f33e786f51a191728db7267248)

#### [v0.3.3](https://github.com/h-enk/doks/compare/v0.3.2...v0.3.3)

> 5 July 2021

- Add Mermaid support [`#369`](https://github.com/h-enk/doks/pull/369)
- Fix lint tests on Linux. [`#373`](https://github.com/h-enk/doks/pull/373)
- feat: add mermaid [`f1fa5c5`](https://github.com/h-enk/doks/commit/f1fa5c5936558ff0b62d8a150bf303629bf50840)
+26 −3
Original line number Diff line number Diff line
@@ -9,11 +9,11 @@
</h1>

<h3 align="center">
  Modern documentation theme
  Modern Documentation Theme
</h3>

<p align="center">
  Doks is a Hugo theme helping you build modern documentation websites that are secure, fast, and SEO-ready — by default.
  Doks is a Hugo theme for building secure, fast, and SEO-ready documentation websites, which you can easily update and customize.
</p>

<p align="center">
@@ -23,6 +23,9 @@
  <a href="https://github.com/h-enk/doks/releases">
    <img src="https://img.shields.io/github/v/release/h-enk/doks?include_prereleases&style=flat-square"alt="GitHub release (latest SemVer including pre-releases)">
  </a>
  <a href="https://www.npmjs.com/package/@hyas/doks">
    <img src="https://img.shields.io/npm/v/@hyas/doks?style=flat-square" alt="npm (scoped)">
  </a>
  <a href="https://github.com/h-enk/doks/actions?query=workflow%3A%22Hyas+CI%22">
    <img src="https://img.shields.io/github/workflow/status/h-enk/doks/Hyas%20CI/master?style=flat-square" alt="GitHub Workflow Status (branch)">
  </a>
@@ -39,7 +42,7 @@

## Why Doks?

Nine reasons why you should use Doks:
Nine main reasons why you should use Doks:

1. __Security aware__. Get A+ scores on [Mozilla Observatory](https://observatory.mozilla.org/analyze/doks.netlify.app) out of the box. Easily change the default Security Headers to suit your needs.

@@ -59,6 +62,14 @@ Nine reasons why you should use Doks:

9. __Dark mode__. Switch to a low-light UI with the click of a button. Change colors with variables to match your branding.

### Other features

- __Multilingual and i18n__ support
- __Versioning__ documentation support
- __KaTeX__ math typesetting
- __Mermaid__ diagrams and visualization
- __highlight.js__ syntax highlighting

## Requirements

Doks uses npm to centralize dependency management, making it [easy to update](https://getdoks.org/docs/help/how-to-update/) resources, build tooling, plugins, and build scripts:
@@ -117,3 +128,15 @@ Doks comes with [commands](https://getdoks.org/docs/prologue/commands/) for comm
- [Netlify Community](https://community.netlify.com/)
- [Hugo Forums](https://discourse.gohugo.io/)
- [Doks Discussions](https://github.com/h-enk/doks/discussions)

## Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website.

[![OC sponsor 0](https://opencollective.com/doks/sponsor/0/avatar.svg)](https://opencollective.com/doks/sponsor/0/website)

## Backers

Support this project by becoming a backer. Your avatar will show up here.

[![Backers](https://opencollective.com/doks/backers.svg)](https://opencollective.com/doks)

SECURITY.md

0 → 100644
+7 −0
Original line number Diff line number Diff line
# Reporting Security Issues

The Doks team and community take security issues in Doks seriously. We appreciate your efforts to responsibly disclose your findings, and will make every effort to acknowledge your contributions.

To report a security issue, email [security@getdoks.org](mailto:security@getdoks.org) and include the word "SECURITY" in the subject line.

We'll endeavor to respond quickly, and will keep you updated throughout the process.
Loading