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

Migrate to mkdocs. #82

Draft
wants to merge 19 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
17 changes: 17 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
root = true

[*]
end_of_line = lf
insert_final_newline = true
trim_trailing_whitespace = true

indent_style = space
indent_size = 4

charset = utf-8

[*.yaml]
indent_size = 2

[*.yml]
indent_size = 2
1 change: 1 addition & 0 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* @nekitdev @Wyliemaster @SMJSGaming
4 changes: 1 addition & 3 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
# Why the hell not?

github: Homurasama, SMJSgaming, NeKitDS, Altenhh, GDColon, 13laze
github: Wyliemaster, nekitdev, SMJSGaming, naoei
28 changes: 28 additions & 0 deletions .github/dependebot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
version: 2

updates:
- package-ecosystem: github-actions
directory: "/"

labels:
- A-dependencies
- P-normal
- S-triage

schedule:
interval: daily

open-pull-requests-limit: 10

- package-ecosystem: pip
directory: "/"

labels:
- A-dependencies
- P-normal
- S-triage

schedule:
interval: daily

open-pull-requests-limit: 10
41 changes: 41 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
name: docs

on:
push:
branches:
- main
- docs

jobs:
docs:
name: Docs
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3

- name: Setup Python 3.10
uses: actions/setup-python@v4
with:
python-version: "3.10"

- name: Update PATH
run: echo "$HOME/.local/bin" >> $GITHUB_PATH

- name: Install Poetry
run: curl -sSL https://install.python-poetry.org/ | python -

- name: Update Poetry
run: poetry self update --preview

- name: Configure Poetry
run: poetry config virtualenvs.in-project true

- name: Install dependencies
run: poetry install --with docs

- name: Pull
run: git pull

- name: Deploy the documentation
run: poetry run mkdocs gh-deploy
21 changes: 19 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,22 @@
node_modules
# editors

.idea/
.vs/

package-lock.json
# virtual environments

.env
env/
env.bak/

.venv
venv/
venv.bak/

# documentation

site/

# remove if lock file should be included

poetry.lock
137 changes: 137 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,137 @@
# Code of Conduct

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, caste, color, religion, or sexual
identity and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.

## Our Standards

Examples of behavior that contributes to a positive environment for our
community include:

* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the overall
community

Examples of unacceptable behavior include:

* The use of sexualized language or imagery, and sexual attention or advances of
any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email address,
without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.

Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.

## Scope

This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official email address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement to
[[email protected]][Email].

All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
reporter of any incident.

## Enforcement Guidelines

Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:

### 1. Correction

**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.

**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.

### 2. Warning

**Community Impact**: A violation through a single incident or series of
actions.

**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or permanent
ban.

### 3. Temporary Ban

**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.

**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.

### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within the
community.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][Home],
version 2.1, available at
[https://contributor-covenant.org/version/2/1/code_of_conduct][v2.1].

Community Impact Guidelines were inspired by
[Mozilla's Code of Conduct enforcement ladder][Mozilla Code of Conduct].

For answers to common questions about this code of conduct, see the FAQ at
[https://contributor-covenant.org/faq][FAQ]. Translations are available at
[https://contributor-covenant.org/translations][Translations].

[Email]: mailto:[email protected]

[Home]: https://contributor-covenant.org/
[v2.1]: https://contributor-covenant.org/version/2/1/code_of_conduct

[Mozilla Code of Conduct]: https://github.com/mozilla/diversity

[FAQ]: https://contributor-covenant.org/faq
[Translations]: https://contributor-covenant.org/translations
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2020 GD Programming
Copyright (c) 2020-present, GD Programming

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
65 changes: 49 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,64 @@
<div align="center">
<img src="https://github.com/gd-programming/gddocs/blob/main/assets/gddocs-icon.png?raw=true" height="128" width="128" alt="book">
</div>
# `gd.docs`

# GDDocs
[![gd.docs][Badge]][gd.docs]

**Some documentation for Geometry Dash's servers, and the game itself.**
**Documentation for Geometry Dash.**

----
`gd.docs` is a project built to openly give advanced information for aspiring developers looking to interface
with *Geometry Dash*. We primarily aim to create this as a website for people to learn more about the inner
workings of *Geometry Dash* along with its data.

**GDDocs** is a project built to openly give advanced information and readable information for aspiring developers looking to interface with Geometry Dash. Primarily, we aim to create this as a website for people to learn more about the inner workings of geometry dash, along with it's data.
You can find the website over [here][gd.docs].

The GDDocs website can be found [here](https://docs.gdprogra.me/#/)
## Installing

## Running/Building
**You will require Node.js `>=12` to debug and run this project.**
**Python 3.7 is required to build the documentation.**

GDDocs is built off of the `docsify` engine, outputted to a generator file to be able to work well on server environments, rather than GitHub pages. This is primarily to allow for easy domain usage and development in a place where it can always update, and be hosted upon locally rather than over GitHub's servers.
Firstly, you need to clone the `gd.docs` repository:

As such, rather than having to install using the package.json; (which we would recommended doing anyways using `npm install`,) the installation and such has been included in `generator.js`.
```console
$ git clone https://github.com/gd-programming/gd.docs
$ cd gd.docs
```

Then you can install the dependencies via:

```console
$ python -m pip install .
```

```plain
node generator.js
Alternatively, if you are using poetry:

```console
$ poetry install
```

To debug it, you will need to properly clone or pull this repository.
## Building

`gd.docs` is built using `mkdocs` library. Building the documentation is as simple as:

```console
$ mkdocs build
```

The result will be placed in the `site` directory.

## Serving

In order to make the documentation easier to work on, one can use the following command:

```console
$ mkdocs serve
```

It will run a local server, updating all changes to documentation on-the-fly.

## Contributing

Contributions are preferably made to the documentation, rather than the simple `generator.js` file; unless need be. Contributions to all aspects of this project are preferred to be made over pull requests and issues. Ideas on what to contribute or read over can be read in the [issues](https://github.com/gd-programming/gddocs/issues) section of this repository.
Contributions to all aspects of this project are preferred to be made over pull requests and issues.
Ideas on what to add or improve can be found in the [issues][Issues] section of this repository.

[gd.docs]: https://docs.gd-programming.org/

[Issues]: https://github.com/gd-programming/gd.docs/issues
[Badge]: https://github.com/gd-programming/gd.docs/workflows/docs/badge.svg
Binary file removed assets/gddocs-icon.png
Binary file not shown.
Binary file added assets/icons/gd.docs.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Empty file removed docs/.nojekyll
Empty file.
1 change: 1 addition & 0 deletions docs/CNAME
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
docs.gd-programming.org
12 changes: 0 additions & 12 deletions docs/CREDITS.md

This file was deleted.

Loading