Skip to content
This repository has been archived by the owner on Jan 12, 2024. It is now read-only.

Commit

Permalink
new version of documentation (via #133)
Browse files Browse the repository at this point in the history
  • Loading branch information
eroshenkoam authored Sep 7, 2021
1 parent 59e6789 commit bc06d3e
Show file tree
Hide file tree
Showing 320 changed files with 30,259 additions and 4,626 deletions.
8 changes: 8 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
root = true

[*]
indent_style = space
indent_size = 2
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true
40 changes: 40 additions & 0 deletions .eslintrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
{
"extends": [
"eslint:recommended",
"plugin:import/errors",
"plugin:react/recommended",
"plugin:jsx-a11y/recommended",
"prettier",
"prettier/react"
],
"plugins": ["react", "import", "jsx-a11y"],
"settings": {
"react": {
"version": "detect"
}
},
"rules": {
"react/prop-types": 0,
"react/react-in-jsx-scope": "off",
"lines-between-class-members": ["error", "always"],
"padding-line-between-statements": "off",
"import/no-unresolved": "off",
"jsx-a11y/click-events-have-key-events": "off"
},
"parser": "babel-eslint",
"parserOptions": {
"ecmaVersion": 10,
"sourceType": "module",
"ecmaFeatures": {
"jsx": true
}
},
"env": {
"es6": true,
"browser": true,
"node": true
},
"globals": {
"graphql": false
}
}
25 changes: 25 additions & 0 deletions .github/release-drafter.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
name-template: '$NEXT_MINOR_VERSION'
tag-template: '$NEXT_MINOR_VERSION'
categories:
- title: '🚀 New Features'
labels:
- 'type:new feature'
- title: '🔬 Improvements'
labels:
- 'type:improvement'
- title: '🐞 Bug Fixes'
labels:
- 'type:bug'
- title: '⬆️ Dependency Updates'
labels:
- 'type:dependencies'

change-template: '* $TITLE (via #$NUMBER) - @$AUTHOR'
exclude-labels:
- 'type:internal'
template: |
$CHANGES
## 👀 Links
[Commits since $PREVIOUS_TAG](https://github.com/allure-framework/allure-docs/compare/$PREVIOUS_TAG...master)
27 changes: 27 additions & 0 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
name: Build

on:
pull_request:
types: [synchronize, opened, reopened, ready_for_review]
branches:
- '*'
push:
branches:
- 'master'

jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Setup Node
uses: actions/setup-node@v1
with:
node-version: 12.x
cache: 'yarn'
- name: Install Deps
run: yarn install
- name: Install Gatsby
run: npm install -g gatsby-cli
- name: Build Gatsby
run: gatsby build
14 changes: 14 additions & 0 deletions .github/workflows/draft-release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
name: Draft Release

on:
push:
branches:
- master

jobs:
update_draft_release:
runs-on: ubuntu-latest
steps:
- uses: release-drafter/release-drafter@v5
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
30 changes: 30 additions & 0 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
name: Publish

on:
release:
types: [ published ]

jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Setup Node
uses: actions/setup-node@v1
with:
node-version: 12.x
cache: 'yarn'
- name: Install Deps
run: yarn install
- name: Install Gatsby
run: npm install -g gatsby-cli
- name: Build Gatsby
run: gatsby build
- name: Docker Publish
uses: docker/build-push-action@v1
with:
registry: ghcr.io
tag_with_ref: true
repository: allure-framework/allure-docs
username: ${{ secrets.PACKAGES_USER }}
password: ${{ secrets.PACKAGES_PASS }}
21 changes: 15 additions & 6 deletions .gitignore
100644 → 100755
Original file line number Diff line number Diff line change
@@ -1,7 +1,16 @@
# Idea
.idea
*.iml
# GatsbyJS
node_modules
public
.cache

# MacOS
*DS_Store
*.env

# Gradle
.gradle
build
# IDE
.vscode/
.idea/
*.iml
*.log
reduxcache*
.generated.config.js
7 changes: 7 additions & 0 deletions .prettierrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"printWidth": 100,
"jsxBracketSameLine": false,
"singleQuote": true,
"tabWidth": 2,
"trailingComma": "es5"
}
6 changes: 3 additions & 3 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
FROM nginx:1.12-alpine
FROM nginx:alpine

COPY build/docs/html5 /usr/share/nginx/html
COPY public /usr/share/nginx/html

EXPOSE 80
EXPOSE 80
40 changes: 0 additions & 40 deletions Jenkinsfile

This file was deleted.

30 changes: 0 additions & 30 deletions README.adoc

This file was deleted.

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

[![Netlify Status](https://api.netlify.com/api/v1/badges/c0cec88f-db01-4c57-8b8d-782e07a9f73f/deploy-status)](https://app.netlify.com/sites/boogi/deploys)
![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/filipowm/boogi)
![CI](https://github.com/filipowm/boogi/workflows/CI/badge.svg)
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/d0d45783a9bb47058b574a8a42d736fd)](https://www.codacy.com/manual/matfilipowicz/BooGi?utm_source=github.com&utm_medium=referral&utm_content=filipowm/BooGi&utm_campaign=Badge_Grade)

Create **awesome documentation** or tutorial pages with modern look-and-feel.
Customize it to your needs, run locally, deploy anywhere.

**Important** Check [boogi-cli](https://github.com/filipowm/boogi-cli) to start
quickly, simplify your codebase, easily run locally and build you BooGi-based app.
We recommend using `boogi-cli` instead of using `gatsby-cli` directly.

## Motivation

Goal is to give teams powerful tool which they can use to efficiently and
collaboratively share their knowledge. They can easily host it on any
infrastructure of choice or SaaS hosting like Netlify, Vercel or
GitHub / GitLab Pages. We want to provide a product, which can be customized
to (nearly) any needs, either using basic or advanced configuration options.

BooGi is inspired by popular [Gitbook](https://gitbook.com) look and feel.
It offers custom styling and components that enable building beautiful documentation
for projects and products quickly. It follows docs-as-code principles, where
you treat your documentation in the same way as your code.

It is a fork of https://github.com/hasura/gatsby-gitbook-starter, however
it went through total rework and changes. We improve it to provide significantly
more features, make look-and-feel more similar to Gitbook, improve stability,
performance, make it more configurable and easier to start with.

## 🔥 Features

- Write using Markdown / [MDX](https://github.com/mdx-js/mdx)
- customizing your page to match your branding and needs
- GitBook-like style theme, inspired by https://docs.gitbook.com/
- light / dark mode themes
- responsive design with mobile / tablet support
- rich-content and rich-text features like text formatting, graphs and diagrams,
quotes, columnar layout, emojis, highlights, live code editor,
syntax highlighting, external code snippets and many many more!
- draft pages
- search integration with [Algolia](https://www.algolia.com/)
- local search (search in a browser without need to integrate with Algolia)
- Progressive Web App which can work offline
- integration with Google Analytics
- full screen mode
- Search Engine Optimization (_SEO_) friendliness
- RSS feed
- easy way to edit content on Gitlab, Github or Bitbucket
- custom CLI to easily initialize and develop BooGi app
- easy deployment on platform of your choice

## 🔗 Docs and live Demo

Here's a [BooGi documentation](https://boogi.netlify.app) being
also a live demo.

## 🚀 Quickstart

### Using `boogi-cli` (recommended)

You need to have `boogi-cli` installed: `npm install -g boogi-cli`.

1. Initialize BooGi project (config wizard will help you to
set it up!) in current directory:
```bash
boogi init
```

2. Run your app in development mode with live reload
```bash
boogi develop
```

3. Build you app package ready for deployment
```bash
boogi build
```

### Using `gatsby-cli`

You need to have `gatsby-cli` installed: `npm install -g gatsby-cli`.

Get started by running the following commands (using Gatsby CLI):

```
$ git clone [email protected]:filipowm/boogi.git
$ yarn
$ gatsby develop
```
Visit `http://localhost:8000/` to view the app.
## ☁️ Deploy
[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/filipowm/boogi)
Loading

0 comments on commit bc06d3e

Please sign in to comment.