meta: Update for Hyas community health files
This commit is contained in:
		
							
								
								
									
										25
									
								
								.github/ISSUE_TEMPLATE/bug-report---.md
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										25
									
								
								.github/ISSUE_TEMPLATE/bug-report---.md
									
									
									
									
										vendored
									
									
								
							@@ -1,25 +0,0 @@
 | 
			
		||||
---
 | 
			
		||||
name: "Bug report \U0001F41E"
 | 
			
		||||
about: Create a report to help us improve
 | 
			
		||||
 | 
			
		||||
---
 | 
			
		||||
 | 
			
		||||
## Description
 | 
			
		||||
 | 
			
		||||
Describe the issue that you're seeing.
 | 
			
		||||
 | 
			
		||||
### Steps to reproduce
 | 
			
		||||
 | 
			
		||||
Clear steps describing how to reproduce the issue. Please please please link to a demo project if possible, this makes your issue _much_ easier to diagnose (seriously).
 | 
			
		||||
 | 
			
		||||
### Expected result
 | 
			
		||||
 | 
			
		||||
What should happen?
 | 
			
		||||
 | 
			
		||||
### Actual result
 | 
			
		||||
 | 
			
		||||
What happened.
 | 
			
		||||
 | 
			
		||||
### Environment
 | 
			
		||||
 | 
			
		||||
Paste the information here as shown by `npm run check`
 | 
			
		||||
							
								
								
									
										9
									
								
								.github/ISSUE_TEMPLATE/config.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										9
									
								
								.github/ISSUE_TEMPLATE/config.yml
									
									
									
									
										vendored
									
									
								
							@@ -1,4 +1,7 @@
 | 
			
		||||
contact_links:
 | 
			
		||||
  - name: Question 🙋
 | 
			
		||||
    url: https://github.com/h-enk/doks/discussions/categories/q-a
 | 
			
		||||
    about: Ask your question in Doks Discussions
 | 
			
		||||
  - name: 📘 Documentation
 | 
			
		||||
    url: https://github.com/gethyas/getdoks.org
 | 
			
		||||
    about: File an issue or make an improvement to the docs website.
 | 
			
		||||
  - name: 💁 Support
 | 
			
		||||
    url: https://github.com/gethyas/doks/discussions
 | 
			
		||||
    about: 'Get help on Hyas Discussions'
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										17
									
								
								.github/ISSUE_TEMPLATE/feature-request---.md
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										17
									
								
								.github/ISSUE_TEMPLATE/feature-request---.md
									
									
									
									
										vendored
									
									
								
							@@ -1,17 +0,0 @@
 | 
			
		||||
---
 | 
			
		||||
name: "Feature request \U0001F680"
 | 
			
		||||
about: Suggest an idea for Doks
 | 
			
		||||
 | 
			
		||||
---
 | 
			
		||||
 | 
			
		||||
## Summary
 | 
			
		||||
 | 
			
		||||
Brief explanation of the feature.
 | 
			
		||||
 | 
			
		||||
### Basic example
 | 
			
		||||
 | 
			
		||||
Include a basic example or links here.
 | 
			
		||||
 | 
			
		||||
### Motivation
 | 
			
		||||
 | 
			
		||||
Why are we doing this? What use cases does it support? What is the expected outcome?
 | 
			
		||||
							
								
								
									
										
											BIN
										
									
								
								.github/assets/banner.png
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										
											BIN
										
									
								
								.github/assets/banner.png
									
									
									
									
										vendored
									
									
								
							
										
											Binary file not shown.
										
									
								
							| 
		 Before Width: | Height: | Size: 710 KiB After Width: | Height: | Size: 709 KiB  | 
							
								
								
									
										11
									
								
								.github/dependabot.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										11
									
								
								.github/dependabot.yml
									
									
									
									
										vendored
									
									
								
							@@ -1,11 +0,0 @@
 | 
			
		||||
# To get started with Dependabot version updates, you'll need to specify which
 | 
			
		||||
# package ecosystems to update and where the package manifests are located.
 | 
			
		||||
# Please see the documentation for all configuration options:
 | 
			
		||||
# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
 | 
			
		||||
 | 
			
		||||
version: 2
 | 
			
		||||
updates:
 | 
			
		||||
  - package-ecosystem: "npm" # See documentation for possible values
 | 
			
		||||
    directory: "/" # Location of package manifests
 | 
			
		||||
    schedule:
 | 
			
		||||
      interval: "daily"
 | 
			
		||||
							
								
								
									
										18
									
								
								.github/pull_request_template.md
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										18
									
								
								.github/pull_request_template.md
									
									
									
									
										vendored
									
									
								
							@@ -1,18 +0,0 @@
 | 
			
		||||
## Summary
 | 
			
		||||
 | 
			
		||||
Brief explanation of the proposed changes.
 | 
			
		||||
 | 
			
		||||
## Basic example
 | 
			
		||||
 | 
			
		||||
Include a basic example, screenshots, or links.
 | 
			
		||||
 | 
			
		||||
## Motivation
 | 
			
		||||
 | 
			
		||||
Why are we doing this? What use cases does it support? What is the expected outcome?
 | 
			
		||||
 | 
			
		||||
## Checks
 | 
			
		||||
 | 
			
		||||
- [ ] Read [Create a Pull Request](https://getdoks.org/docs/contributing/how-to-contribute/#create-a-pull-request)
 | 
			
		||||
- [ ] Supports all screen sizes (if relevant)
 | 
			
		||||
- [ ] Supports both light and dark mode (if relevant)
 | 
			
		||||
- [ ] Passes `npm run test`
 | 
			
		||||
							
								
								
									
										61
									
								
								.github/workflows/codeql-analysis.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										61
									
								
								.github/workflows/codeql-analysis.yml
									
									
									
									
										vendored
									
									
								
							@@ -1,61 +0,0 @@
 | 
			
		||||
name: "Code Scanning"
 | 
			
		||||
 | 
			
		||||
on:
 | 
			
		||||
  push:
 | 
			
		||||
    branches: [master]
 | 
			
		||||
  pull_request:
 | 
			
		||||
    branches: [master]
 | 
			
		||||
  schedule:
 | 
			
		||||
    #        ┌───────────── minute (0 - 59)
 | 
			
		||||
    #        │  ┌───────────── hour (0 - 23)
 | 
			
		||||
    #        │  │ ┌───────────── day of the month (1 - 31)
 | 
			
		||||
    #        │  │ │ ┌───────────── month (1 - 12 or JAN-DEC)
 | 
			
		||||
    #        │  │ │ │ ┌───────────── day of the week (0 - 6 or SUN-SAT)
 | 
			
		||||
    #        │  │ │ │ │
 | 
			
		||||
    #        │  │ │ │ │
 | 
			
		||||
    #        │  │ │ │ │
 | 
			
		||||
    #        *  * * * *
 | 
			
		||||
    - cron: '30 1 * * 0'
 | 
			
		||||
 | 
			
		||||
jobs:
 | 
			
		||||
  CodeQL-Build:
 | 
			
		||||
    # CodeQL runs on ubuntu-latest, windows-latest, and macos-latest
 | 
			
		||||
    runs-on: ubuntu-latest
 | 
			
		||||
 | 
			
		||||
    permissions:
 | 
			
		||||
      # required for all workflows
 | 
			
		||||
      security-events: write
 | 
			
		||||
 | 
			
		||||
      # only required for workflows in private repositories
 | 
			
		||||
      actions: read
 | 
			
		||||
      contents: read
 | 
			
		||||
 | 
			
		||||
    steps:
 | 
			
		||||
      - name: Checkout repository
 | 
			
		||||
        uses: actions/checkout@v3
 | 
			
		||||
 | 
			
		||||
      # Initializes the CodeQL tools for scanning.
 | 
			
		||||
      - name: Initialize CodeQL
 | 
			
		||||
        uses: github/codeql-action/init@v2
 | 
			
		||||
        # Override language selection by uncommenting this and choosing your languages
 | 
			
		||||
        with:
 | 
			
		||||
          languages: javascript
 | 
			
		||||
 | 
			
		||||
      # Autobuild attempts to build any compiled languages (C/C++, C#, Go, or Java).
 | 
			
		||||
      # If this step fails, then you should remove it and run the build manually (see below).
 | 
			
		||||
      - name: Autobuild
 | 
			
		||||
        uses: github/codeql-action/autobuild@v2
 | 
			
		||||
 | 
			
		||||
      # ℹ️ Command-line programs to run using the OS shell.
 | 
			
		||||
      # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
 | 
			
		||||
 | 
			
		||||
      # ✏️ If the Autobuild fails above, remove it and uncomment the following
 | 
			
		||||
      #    three lines and modify them (or add more) to build your code if your
 | 
			
		||||
      #    project uses a compiled language
 | 
			
		||||
 | 
			
		||||
      #- run: |
 | 
			
		||||
      #     make bootstrap
 | 
			
		||||
      #     make release
 | 
			
		||||
 | 
			
		||||
      - name: Perform CodeQL Analysis
 | 
			
		||||
        uses: github/codeql-action/analyze@v2
 | 
			
		||||
@@ -2,9 +2,9 @@ name: Hyas CI
 | 
			
		||||
 | 
			
		||||
on:
 | 
			
		||||
  push:
 | 
			
		||||
    branches: master
 | 
			
		||||
    branches: main
 | 
			
		||||
  pull_request:
 | 
			
		||||
    branches: master
 | 
			
		||||
    branches: main
 | 
			
		||||
 | 
			
		||||
jobs:
 | 
			
		||||
  build:
 | 
			
		||||
@@ -20,28 +20,19 @@ jobs:
 | 
			
		||||
    - name: Checkout
 | 
			
		||||
      uses: actions/checkout@v3
 | 
			
		||||
    
 | 
			
		||||
    - name: Setup PNPM
 | 
			
		||||
      uses: pnpm/action-setup@v2
 | 
			
		||||
      with:
 | 
			
		||||
        version: 8
 | 
			
		||||
 | 
			
		||||
    - name: Setup node@${{ matrix.node-version }}
 | 
			
		||||
      uses: actions/setup-node@v3
 | 
			
		||||
      with:
 | 
			
		||||
        node-version: ${{ matrix.node-version }}
 | 
			
		||||
        cache: 'pnpm'
 | 
			
		||||
 | 
			
		||||
    - name: Install dependencies
 | 
			
		||||
      run: pnpm install
 | 
			
		||||
      run: npm ci
 | 
			
		||||
 | 
			
		||||
    # - name: Run formatter
 | 
			
		||||
    #   run: pnpm format --if-present
 | 
			
		||||
 | 
			
		||||
    # - name: Run linters
 | 
			
		||||
    #   run: pnpm lint --if-present
 | 
			
		||||
    - name: Run linters
 | 
			
		||||
      run: npm run lint --if-present
 | 
			
		||||
 | 
			
		||||
    - name: Build site
 | 
			
		||||
      run: pnpm build
 | 
			
		||||
      run: npm run build
 | 
			
		||||
 | 
			
		||||
    # - name: Run tests
 | 
			
		||||
    #   run: pnpm test --if-present
 | 
			
		||||
    #   run: npm test --if-present
 | 
			
		||||
@@ -3,9 +3,9 @@
 | 
			
		||||
# - https://www.gitpod.io/docs/configure/workspaces/tasks#one-line-tasks
 | 
			
		||||
 | 
			
		||||
tasks:
 | 
			
		||||
  - name: Dev Server
 | 
			
		||||
  - name: Run development server
 | 
			
		||||
    init: pnpm install
 | 
			
		||||
    command: pnpm clean:build && pnpm dev:gitpod
 | 
			
		||||
    command: pnpm dev
 | 
			
		||||
 | 
			
		||||
ports:
 | 
			
		||||
  - port: 1313
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										2
									
								
								LICENSE
									
									
									
									
									
								
							
							
						
						
									
										2
									
								
								LICENSE
									
									
									
									
									
								
							@@ -1,6 +1,6 @@
 | 
			
		||||
MIT License
 | 
			
		||||
 | 
			
		||||
Copyright (c) 2020-present Henk Verlinde
 | 
			
		||||
Copyright (c) 2023 Hyas
 | 
			
		||||
 | 
			
		||||
Permission is hereby granted, free of charge, to any person obtaining a copy
 | 
			
		||||
of this software and associated documentation files (the "Software"), to deal
 | 
			
		||||
 
 | 
			
		||||
@@ -2,9 +2,9 @@
 | 
			
		||||
 | 
			
		||||
<p align="center">
 | 
			
		||||
  <br/>
 | 
			
		||||
  <a href="https://getdoks.org/">Doks</a> is a theme for building custom, production-ready documentation websites.
 | 
			
		||||
  <a href="https://getdoks.org/">Doks</a> is a fast, flexible, and easy-to-use documentation theme built on <a href="https://gethyas.com/">Hyas</a> — 
 | 
			
		||||
  <br/>
 | 
			
		||||
  Powered by <a href="https://gethyas.com/">Hyas</a> — the all-in-one Hugo framework designed for ease of use.
 | 
			
		||||
  the all-in-one Hugo-npm framework.
 | 
			
		||||
  <br/><br/>
 | 
			
		||||
</p>
 | 
			
		||||
 | 
			
		||||
 
 | 
			
		||||
@@ -1,7 +1,7 @@
 | 
			
		||||
---
 | 
			
		||||
title : "Modern Documentation Theme"
 | 
			
		||||
description: "Jumpstart your next documentation project with Doks. Build a custom, production-ready documentation website in no time."
 | 
			
		||||
lead: "Jumpstart your next documentation project with Doks. Build a custom, production-ready documentation website in no time."
 | 
			
		||||
description: "Build beautiful, high-performance documentation websites with Doks. Fast, flexible, and easy-to-use. Deploy anywhere."
 | 
			
		||||
lead: "Build beautiful, high-performance documentation websites with Doks. Fast, flexible, and easy-to-use. Deploy anywhere."
 | 
			
		||||
date: 2020-10-06T08:47:36+00:00
 | 
			
		||||
lastmod: 2020-10-06T08:47:36+00:00
 | 
			
		||||
draft: false
 | 
			
		||||
 
 | 
			
		||||
@@ -2,7 +2,7 @@
 | 
			
		||||
title: "Doks 1.0"
 | 
			
		||||
slug: "doks-1"
 | 
			
		||||
description: ""
 | 
			
		||||
summary: "Doks 1.0 is here! Doks is a Hyas theme for building custom, production-ready documentation websites."
 | 
			
		||||
summary: "Doks 1.0 is here! Doks is a fast, flexible, and easy-to-use documentation theme built on Hyas."
 | 
			
		||||
date: 2023-05-17T09:15:34+02:00
 | 
			
		||||
lastmod: 2023-05-17T09:15:34+02:00
 | 
			
		||||
draft: false
 | 
			
		||||
 
 | 
			
		||||
@@ -16,7 +16,7 @@ toc: true
 | 
			
		||||
 | 
			
		||||
## What is Doks?
 | 
			
		||||
 | 
			
		||||
Doks is a [Hyas](https://gethyas.com/) theme for building custom, production-ready documentation websites.
 | 
			
		||||
Doks is a fast, flexible, and easy-to-use documentation theme built on [Hyas](https://gethyas.com/).
 | 
			
		||||
 | 
			
		||||
## Key Features
 | 
			
		||||
 | 
			
		||||
 
 | 
			
		||||
										
											Binary file not shown.
										
									
								
							| 
		 Before Width: | Height: | Size: 902 KiB After Width: | Height: | Size: 801 KiB  | 
							
								
								
									
										
											BIN
										
									
								
								images/tn.png
									
									
									
									
									
								
							
							
						
						
									
										
											BIN
										
									
								
								images/tn.png
									
									
									
									
									
								
							
										
											Binary file not shown.
										
									
								
							| 
		 Before Width: | Height: | Size: 491 KiB After Width: | Height: | Size: 500 KiB  | 
							
								
								
									
										31
									
								
								package.json
									
									
									
									
									
								
							
							
						
						
									
										31
									
								
								package.json
									
									
									
									
									
								
							@@ -1,11 +1,15 @@
 | 
			
		||||
{
 | 
			
		||||
  "name": "doks",
 | 
			
		||||
  "version": "1.0.0-rc.1",
 | 
			
		||||
  "version": "1.0.0-rc.2",
 | 
			
		||||
  "description": "Doks theme",
 | 
			
		||||
  "main": "index.js",
 | 
			
		||||
  "author": "Hyas",
 | 
			
		||||
  "license": "MIT",
 | 
			
		||||
  "repository": {
 | 
			
		||||
    "type": "git",
 | 
			
		||||
    "url": "https://github.com/gethyas/doks.git"
 | 
			
		||||
  },
 | 
			
		||||
  "scripts": {
 | 
			
		||||
    "dev": "exec-bin node_modules/.bin/hugo/hugo server --bind=0.0.0.0 --disableFastRender --baseURL=http://localhost --noHTTPCache",
 | 
			
		||||
    "dev:gitpod": "exec-bin node_modules/.bin/hugo/hugo server --disableFastRender --baseUrl $(gp url 1313) --liveReloadPort=443 --appendPort=false --bind=0.0.0.0",
 | 
			
		||||
    "dev:drafts": "exec-bin node_modules/.bin/hugo/hugo server --bind=0.0.0.0 --disableFastRender --baseURL=http://localhost --noHTTPCache --buildDrafts",
 | 
			
		||||
    "create": "exec-bin node_modules/.bin/hugo/hugo new",
 | 
			
		||||
    "lint": "npm run lint:markdown",
 | 
			
		||||
@@ -25,28 +29,15 @@
 | 
			
		||||
    "postinstall": "shx rm -rf node_modules/.bin/hugo && shx mkdir node_modules/.bin/hugo && shx cp node_modules/gethyas/node_modules/.bin/hugo/* node_modules/.bin/hugo",
 | 
			
		||||
    "version": "auto-changelog -p && git add CHANGELOG.md"
 | 
			
		||||
  },
 | 
			
		||||
  "repository": {
 | 
			
		||||
    "type": "git",
 | 
			
		||||
    "url": "git+https://github.com/hyas/doks.git"
 | 
			
		||||
  "dependencies": {
 | 
			
		||||
    "@hyas/doks-core": "^1.0.3"
 | 
			
		||||
  },
 | 
			
		||||
  "keywords": [
 | 
			
		||||
    "doks",
 | 
			
		||||
    "hyas",
 | 
			
		||||
    "hugo"
 | 
			
		||||
  ],
 | 
			
		||||
  "author": "Henk Verlinde",
 | 
			
		||||
  "license": "MIT",
 | 
			
		||||
  "bugs": {
 | 
			
		||||
    "url": "https://github.com/gethyas/doks/issues"
 | 
			
		||||
  },
 | 
			
		||||
  "homepage": "https://github.com/gethyas/doks#readme",
 | 
			
		||||
  "devDependencies": {
 | 
			
		||||
    "@hyas/doks-core": "^1.0.1",
 | 
			
		||||
    "auto-changelog": "^2.4.0"
 | 
			
		||||
  },
 | 
			
		||||
  "engines": {
 | 
			
		||||
    "node": ">=16.12.0",
 | 
			
		||||
    "pnpm": ">=8.2.0"
 | 
			
		||||
    "pnpm": ">=8.6.2"
 | 
			
		||||
  },
 | 
			
		||||
  "packageManager": "pnpm@8.6.0"
 | 
			
		||||
  "packageManager": "pnpm@8.6.2"
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										1343
									
								
								pnpm-lock.yaml
									
									
									
										generated
									
									
									
								
							
							
						
						
									
										1343
									
								
								pnpm-lock.yaml
									
									
									
										generated
									
									
									
								
							
										
											
												File diff suppressed because it is too large
												Load Diff
											
										
									
								
							
										
											
												File diff suppressed because it is too large
												Load Diff
											
										
									
								
							@@ -1 +0,0 @@
 | 
			
		||||
{"Target":"main.5764e09131471d91e66e2b1757869741143bc2a0e808825ba7ec979487789a9344377e06298034b26a019602888b2ebf02ce982f2404fb98f8ca42c92544e74c.css","MediaType":"text/css","Data":{"Integrity":"sha512-V2TgkTFHHZHmbisXV4aXQRQ7wqDoCIJbp+yXlId4mpNEN34GKYA0smoBlgKIiy6/As6YLyQE+5j4ykLJJUTnTA=="}}
 | 
			
		||||
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							@@ -0,0 +1 @@
 | 
			
		||||
{"Target":"main.c99deccbfc057753a0a5091b75ff46cae88dd4c3d25a1ee61634b24e84afe88b9e17d96aae1de064c0076194222bffc7848dc213479955268a344541b558ffba.css","MediaType":"text/css","Data":{"Integrity":"sha512-yZ3sy/wFd1OgpQkbdf9GyuiN1MPSWh7mFjSyToSv6IueF9lqrh3gZMAHYZQiK//HhI3CE0eZVSaKNEVBtVj/ug=="}}
 | 
			
		||||
@@ -1,9 +1,9 @@
 | 
			
		||||
name = "Doks"
 | 
			
		||||
license = "MIT"
 | 
			
		||||
licenselink = "https://github.com/h-enk/doks/blob/master/LICENSE"
 | 
			
		||||
description = "Jumpstart your next documentation project with Doks. Build a custom, production-ready documentation website in no time."
 | 
			
		||||
licenselink = "https://github.com/gethyas/doks/blob/master/LICENSE"
 | 
			
		||||
description = "Build beautiful, high-performance documentation websites with Doks. Fast, flexible, and easy-to-use. Deploy anywhere."
 | 
			
		||||
 | 
			
		||||
homepage = "https://github.com/h-enk/doks"
 | 
			
		||||
homepage = "https://github.com/gethyas/doks"
 | 
			
		||||
demosite = "https://doks.netlify.app"
 | 
			
		||||
 | 
			
		||||
tags = ["landing page", "documentation", "blog", "minimal", "modern", "customizable", "search", "dark mode", "bootstrap"]
 | 
			
		||||
 
 | 
			
		||||
		Reference in New Issue
	
	Block a user