Skip to content

Commit

Permalink
Init repo
Browse files Browse the repository at this point in the history
  • Loading branch information
ameshkov committed Mar 22, 2022
0 parents commit 3246e4e
Show file tree
Hide file tree
Showing 36 changed files with 12,708 additions and 0 deletions.
33 changes: 33 additions & 0 deletions .github/workflows/workflow.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
name: Build and deploy

on:
push:
branches:
- "*"
tags:
- v*
pull_request:
workflow_dispatch:

jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Use Node.js
uses: actions/setup-node@v1
with:
node-version: 14.x

- name: yarn install
run: yarn install

- name: yarn build
run: yarn build

- name: deploy
if: github.ref == 'refs/heads/main'
uses: JamesIves/github-pages-deploy-action@4.1.8
with:
branch: gh-pages
folder: build
20 changes: 20 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Dependencies
/node_modules

# Production
/build

# Generated files
.docusaurus
.cache-loader

# Misc
.DS_Store
.env.local
.env.development.local
.env.test.local
.env.production.local

npm-debug.log*
yarn-debug.log*
yarn-error.log*
36 changes: 36 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Website

This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.

`main` branch is published automatically to https://adguardteam.github.io/KnowledgeBaseVPN/.

## How to develop

### Prepare

First of all, you need to install the following:

- [git](https://github.com/git-guides/install-git)
- [yarn](https://classic.yarnpkg.com/lang/en/docs/install/)

Second, clone this repo to your local computer:

- `git clone git@github.com:AdguardTeam/KnowledgeBaseVPN.git`

Alternatively, you can use the [Github app](https://desktop.github.com/) to do that.

Then you should open Terminal on your computer and navigate to the directory where you cloned this repo and run this command to install the local dependencies:

- `yarn install`

### How to run it locally

- `yarn start`

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

## How to build it

- `yarn build`

This command generates static content into the `build` directory and can be served using any static contents hosting service.
3 changes: 3 additions & 0 deletions babel.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
module.exports = {
presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
};
32 changes: 32 additions & 0 deletions crowdin.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
project_id: '471118'
api_token_env: 'CROWDIN_PERSONAL_TOKEN'
preserve_hierarchy: true
files: [
# JSON translation files
{
source: '/i18n/en/**/*',
translation: '/i18n/%two_letters_code%/**/%original_file_name%',
},
# Docs Markdown files
{
source: '/docs/**/*',
translation: '/i18n/%two_letters_code%/docusaurus-plugin-content-docs/current/**/%original_file_name%',
ignore: [
"/**/assets"
]
},
{
source: '/vpn/**/*',
translation: '/i18n/%two_letters_code%/docusaurus-plugin-content-docs-vpn/current/**/%original_file_name%',
ignore: [
"/**/assets"
]
},
{
source: '/miscellaneous/**/*',
translation: '/i18n/%two_letters_code%/docusaurus-plugin-content-docs-miscellaneous/current/**/%original_file_name%',
ignore: [
"/**/assets"
]
}
]
6 changes: 6 additions & 0 deletions docs/general/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"position": 2,
"label": "General",
"collapsible": true,
"collapsed": true
}
Loading

0 comments on commit 3246e4e

Please sign in to comment.