Skip to content

Commit

Permalink
feat: move to armonik-docs-theme
Browse files Browse the repository at this point in the history
  • Loading branch information
esoubiran-aneo committed Mar 21, 2023
1 parent da08b06 commit fdf4cec
Show file tree
Hide file tree
Showing 23 changed files with 7,175 additions and 7 deletions.
4 changes: 4 additions & 0 deletions .eslintignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
dist
node_modules
.output
.nuxt
8 changes: 8 additions & 0 deletions .eslintrc.cjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
module.exports = {
root: true,
extends: '@nuxt/eslint-config',
rules: {
'vue/max-attributes-per-line': 'off',
'vue/multi-word-component-names': 'off'
}
}
12 changes: 12 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
node_modules
*.iml
.idea
*.log*
.nuxt
.vscode
.DS_Store
coverage
dist
sw.*
.env
.output
2 changes: 2 additions & 0 deletions .npmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
shamefully-hoist=true
strict-peer-dependencies=false
1 change: 0 additions & 1 deletion 1.sign-cla.md

This file was deleted.

5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# ArmoniK Community

All our ways of working and our good practices.

[Get Started](https://aneoconsulting.github.io/ArmoniK.Community)
14 changes: 14 additions & 0 deletions app.config.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
export default defineAppConfig({
docus: {
title: "ArmoniK.Community",
description: "All our ways of working and our good practices.",
socials: {
github: 'aneoconsulting/ArmoniK.Community',
},
github: {
dir: 'content',
repo: 'ArmoniK.Community',
owner: 'aneoconsulting',
},
}
})
23 changes: 23 additions & 0 deletions content/0.index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
title: ArmoniK Community
navigation: false
main.fluid: false
layout: page
---

::block-hero
---
cta:
- Get Started
- /introduction
secondary:
- Open on GitHub →
- https://github.com/aneoconsulting/ArmoniK.Community
---

#title
ArmoniK Community

#description
All our ways of working and our good practices
::
9 changes: 7 additions & 2 deletions 0.introduction.md → content/1.introduction.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: Introduction
navigation.icon: heroicons:play
---

# ArmoniK

Hi! We are excited that you are interested in ArmoniK and want to make it even better! This document is a general guide we would like our contributors to follow. Before submitting your contribution, please make sure to take a moment and read through the following guide.
Expand Down Expand Up @@ -27,7 +32,7 @@ In addition to processes and **for each language** you could find in ArmoniK, we
Feel free to ask if there is something you don't understand. The whole ArmoniK team would be delighted to answer you.


## Before starting your jouney
## Before starting your journey

<!-- Here, we need to talk about signing the CLA and why it's important. -->
<!-- For the how, check the 1.sign-cla.md file. -->
<!-- For the how, check the 1.sign-cla.md file. -->
7 changes: 7 additions & 0 deletions content/2.sign-cla.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: Sign the CLA
navigation.icon: lucide:file-signature
---

<!-- In the file, you explain how the cla can be signed. -->
*Work in progress*
File renamed without changes.
File renamed without changes.
3 changes: 3 additions & 0 deletions content/2.working-processes/_dir.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
title: Working Processes
navigation.icon: carbon:integration
redirect: /working-processes/discuss-first
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@
# Contributing Guide to TypeScript projects
---
title: TypeScript projects
navigation.icon: vscode-icons:file-type-typescript-official
---

# TypeScript projects

We are really excited that you are interested in contributing. This is a general contribution guide for ArmoniK's projects written in TypeScript. Before submitting your contribution, please make sure to take a moment and read through the following guide:

Expand Down Expand Up @@ -52,4 +57,4 @@ After bumpping, we remove lock file, we install them, runing build and test to v

Please refer to [release processes](../2.working-processes/3.release-processes.md) in our working processes.

> This guide is heavily inpired by the contribute from [@antfu](https://github.com/antfu/).
> This guide is heavily inpired by the contribute from [@antfu](https://github.com/antfu/).
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@
# Contributing guide to Documentation
---
title: Documentation
navigation.icon: heroicons:document-text
---

# Documentation

We are really excited that you are interested in contributing. This is a general contribution guide for ArmoniK's documentations. Before submitting your contribution, please make sure to take a moment and read through the following guide.

Expand Down Expand Up @@ -27,4 +32,4 @@ Please refer to related release processes:
- [Discuss First](../2.working-processes/1.discuss-first.md)
- [Submission Guidelines](../2.working-processes/2.submission-guidelines.md)

For more informations, please refer to [the docs documentation](https://aneoconsulting.github.io/armonik-docs-theme/).
For more informations, please refer to [the docs documentation](https://aneoconsulting.github.io/armonik-docs-theme/).
3 changes: 3 additions & 0 deletions content/3.contribution-guides/_dir.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
title: Contribution Guides
navigation.icon: carbon:code-reference
redirect: /contribution-guides/typescript
18 changes: 18 additions & 0 deletions nuxt.config.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
const baseURL = process.env.NODE_ENV === "production" ? "/ArmoniK.Community/" : "/";

export default defineNuxtConfig({
app: {
baseURL: baseURL,
head: {
link: [
{
rel: 'icon',
type: 'image/ico',
href: `${baseURL}favicon.ico`,
}
]
}
},

extends: "@aneoconsultingfr/armonik-docs-theme",
})
19 changes: 19 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
{
"name": "armonik-community",
"version": "0.1.0",
"private": true,
"scripts": {
"dev": "nuxi dev",
"build": "nuxi build",
"generate": "nuxi generate",
"preview": "nuxi preview",
"lint": "eslint ."
},
"dependencies": {
"@nuxt/eslint-config": "^0.1.1",
"eslint": "^8.35.0",
"nuxt": "^3.2.2",
"rollup": "3.18.0",
"@aneoconsultingfr/armonik-docs-theme": "^0.5.3"
}
}
Loading

0 comments on commit fdf4cec

Please sign in to comment.