Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs/contributing and issues #68

Open
wants to merge 26 commits into
base: master
Choose a base branch
from
Open
Changes from 1 commit
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
4e5e9c0
chore(deps-dev): bump taskipy from 1.8.2 to 1.9.0
dependabot[bot] Sep 28, 2021
fbc8dff
chore(deps): bump ujson from 4.1.0 to 4.2.0
dependabot[bot] Sep 28, 2021
2be6520
Merge pull request #33 from Heptagram-Bot/feat/landing-page
Vyvy-vi Sep 30, 2021
db6925e
chore(release): v0.6.0
invalid-email-address Sep 30, 2021
dbcf688
chore: add standard lables import action
jaspermayone Sep 30, 2021
acd89d0
feat: docs for docsify
Vyvy-vi Oct 1, 2021
42eb078
chore: format project code
Vyvy-vi Oct 1, 2021
c1bb592
chore(cd): fix dockerfile
Vyvy-vi Oct 2, 2021
1f25d47
chore(cd): update dockerfile to run with HTTPS?
Vyvy-vi Oct 2, 2021
8754e03
chore: fix mixed content issue
Vyvy-vi Oct 2, 2021
8508e9c
docs: sub-divide docs pages
Vyvy-vi Oct 8, 2021
29941bf
fix(web): defered execution of js
Vyvy-vi Oct 8, 2021
f6cc183
docs: add CONTRIBUTING.md and Issue Templates
MidouWebDev Sep 28, 2021
99a3eb8
chore: add requested changes
MidouWebDev Sep 28, 2021
880d6c1
chore(deps-dev): bump taskipy from 1.8.2 to 1.9.0
dependabot[bot] Sep 28, 2021
c78b4a0
chore(deps): bump ujson from 4.1.0 to 4.2.0
dependabot[bot] Sep 28, 2021
21aa434
docs: set up documentation with docsify
Vyvy-vi Oct 1, 2021
2b9f998
chore: fix mixed content issue
Vyvy-vi Oct 2, 2021
5e5d528
docs: add Contributor Covenant Code of Conduct v2.1
Panquesito7 Oct 7, 2021
eaec403
chore(deps): bump fastapi from 0.68.1 to 0.68.2
dependabot[bot] Oct 6, 2021
a3de273
chore(deps): bump jinja2 from 3.0.1 to 3.0.2
dependabot[bot] Oct 8, 2021
05571e0
chore(deps): bump pytest-cov from 2.12.1 to 3.0.0
dependabot[bot] Oct 8, 2021
45cc55c
chore(deps): bump fastapi from 0.68.2 to 0.70.0
dependabot[bot] Oct 8, 2021
8bb890a
chore: update bug template and format files
Vyvy-vi Oct 8, 2021
b83bcd2
fix: remove unused css and templates
Vyvy-vi Oct 30, 2021
56a034f
feat: add redirect on '/legals'
Vyvy-vi Oct 30, 2021
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
chore: format project code
  • Loading branch information
Vyvy-vi committed Oct 2, 2021

Unverified

This commit is not signed, but one or more authors requires that any commit attributed to them is signed.
commit 42eb07894f276754d45c5225149d6f3734915606
1 change: 0 additions & 1 deletion guide/_sidebar.md
Original file line number Diff line number Diff line change
@@ -15,4 +15,3 @@

- [API Docs](https://api.heptagram.xyz/docs)
- [Support Server](https://discord.gg/HSupF99kpq)

1 change: 0 additions & 1 deletion guide/contributing.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
Thanks for showing interest in our project!

Before you start working on your issue, it is recommended that you check out the `CONTRIBUTION.md` and the `CODE_OF_CONDUCT.md, similar to how animated emojis begin.

2 changes: 1 addition & 1 deletion guide/features.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Features

This API has a variety of end-points for different features. For more detailed information, check out the [API docs](https://api.heptagram.xyz/docs).
This API has a variety of end-points for different features. For more detailed information, check out the [API docs](https://api.heptagram.xyz/docs).

Here are some of the features:

118 changes: 1 addition & 117 deletions guide/quickstart.md
Original file line number Diff line number Diff line change
@@ -1,118 +1,2 @@
# Quick start

It is recommended to install `docsify-cli` globally, which helps initializing and previewing the website locally.

```bash
npm i docsify-cli -g
```

## Initialize

If you want to write the documentation in the `./docs` subdirectory, you can use the `init` command.

```bash
docsify init ./docs
```

## Writing content

After the `init` is complete, you can see the file list in the `./docs` subdirectory.

* `index.html` as the entry file
* `README.md` as the home page
* `.nojekyll` prevents GitHub Pages from ignoring files that begin with an underscore

You can easily update the documentation in `./docs/README.md`, of course you can add [more pages](more-pages.md).

## Preview your site

Run the local server with `docsify serve`. You can preview your site in your browser on `http://localhost:3000`.

```bash
docsify serve docs
```

?> For more use cases of `docsify-cli`, head over to the [docsify-cli documentation](https://github.com/docsifyjs/docsify-cli).

## Manual initialization

If you don't like `npm` or have trouble installing the tool, you can manually create `index.html`:

```html
<!-- index.html -->

<!DOCTYPE html>
<html>
<head>
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<meta name="viewport" content="width=device-width,initial-scale=1">
<meta charset="UTF-8">
<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify@4/themes/vue.css" />
</head>
<body>
<div id="app"></div>
<script>
window.$docsify = {
//...
}
</script>
<script src="//cdn.jsdelivr.net/npm/docsify@4"></script>
</body>
</html>
```

### Specifying docsify versions

?> Note that in both of the examples below, docsify URLs will need to be manually updated when a new major version of docsify is released (e.g. `v4.x.x` => `v5.x.x`). Check the docsify website periodically to see if a new major version has been released.

Specifying a major version in the URL (`@4`) will allow your site will receive non-breaking enhancements (i.e. "minor" updates) and bug fixes (i.e. "patch" updates) automatically. This is the recommended way to load docsify resources.

```html
<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify@4/themes/vue.css" />
<script src="//cdn.jsdelivr.net/npm/docsify@4"></script>
```

If you prefer to lock docsify to a specific version, specify the full version after the `@` symbol in the URL. This is the safest way to ensure your site will look and behave the same way regardless of any changes made to future versions of docsify.

```html
<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify@4.11.4/themes/vue.css">
<script src="//cdn.jsdelivr.net/npm/docsify@4.11.4"></script>
```

### Manually preview your site

If you installed python on your system, you can easily use it to run a static server to preview your site.

```python2
cd docs && python -m SimpleHTTPServer 3000
```
```python3
cd docs && python -m http.server 3000
```

## Loading dialog

If you want, you can show a loading dialog before docsify starts to render your documentation:

```html
<!-- index.html -->

<div id="app">Please wait...</div>
```

You should set the `data-app` attribute if you changed `el`:

```html
<!-- index.html -->

<div data-app id="main">Please wait...</div>

<script>
window.$docsify = {
el: '#main'
}
</script>
```

Compare [el configuration](configuration.md#el).

## TODO