Skip to content

Commit 13ed6be

Browse files
committed
Add docusaurus config
Signed-off-by: Sayan Nandan <[email protected]>
1 parent 03b851a commit 13ed6be

File tree

294 files changed

+17690
-662
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

294 files changed

+17690
-662
lines changed

.gitignore

+36-3
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,36 @@
1-
**/site
2-
**/target
3-
**/docbuilder/actions.json*
1+
.DS_Store
2+
.vscode
3+
.idea
4+
*.iml
5+
*.code-workspace
6+
.changelog
7+
8+
node_modules
9+
.yarn
10+
11+
.eslintcache
12+
13+
yarn-error.log
14+
build
15+
coverage
16+
.docusaurus
17+
.cache-loader
18+
types
19+
test-website
20+
21+
packages/docusaurus/lib/
22+
packages/docusaurus-*/lib/*
23+
!packages/docusaurus-1.x/lib/*
24+
packages/docusaurus-1.x/lib/core/metadata.js
25+
packages/docusaurus-1.x/lib/core/MetadataBlog.js
26+
packages/docusaurus-*/lib-next/
27+
28+
website/netlifyDeployPreview/*
29+
!website/netlifyDeployPreview/index.html
30+
!website/netlifyDeployPreview/_redirects
31+
32+
website-1.x-migrated
33+
34+
website/i18n/**/*
35+
#!website/i18n/fr
36+
#!website/i18n/fr/**/*

LICENSE

+13-13
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ exhaustive, and do not form part of our licenses.
3333
material not subject to the license. This includes other CC-
3434
licensed material, or material used under an exception or
3535
limitation to copyright. More considerations for licensors:
36-
wiki.creativecommons.org/Considerations_for_licensors
36+
wiki.creativecommons.org/Considerations_for_licensors
3737

3838
Considerations for the public: By using one of our public
3939
licenses, a licensor grants the public permission to use the
@@ -50,7 +50,7 @@ exhaustive, and do not form part of our licenses.
5050
Although not required by our licenses, you are encouraged to
5151
respect those requests where reasonable. More considerations
5252
for the public:
53-
wiki.creativecommons.org/Considerations_for_licensees
53+
wiki.creativecommons.org/Considerations_for_licensees
5454

5555
=======================================================================
5656

@@ -407,21 +407,21 @@ Section 8 -- Interpretation.
407407

408408
=======================================================================
409409

410-
Creative Commons is not a party to its public
411-
licenses. Notwithstanding, Creative Commons may elect to apply one of
412-
its public licenses to material it publishes and in those instances
413-
will be considered the “Licensor.” The text of the Creative Commons
414-
public licenses is dedicated to the public domain under the CC0 Public
415-
Domain Dedication. Except for the limited purpose of indicating that
416-
material is shared under a Creative Commons public license or as
417-
otherwise permitted by the Creative Commons policies published at
410+
Creative Commons is not a party to its public licenses.
411+
Notwithstanding, Creative Commons may elect to apply one of its public
412+
licenses to material it publishes and in those instances will be
413+
considered the “Licensor.” The text of the Creative Commons public
414+
licenses is dedicated to the public domain under the CC0 Public Domain
415+
Dedication. Except for the limited purpose of indicating that material
416+
is shared under a Creative Commons public license or as otherwise
417+
permitted by the Creative Commons policies published at
418418
creativecommons.org/policies, Creative Commons does not authorize the
419419
use of the trademark "Creative Commons" or any other trademark or logo
420420
of Creative Commons without its prior written consent including,
421421
without limitation, in connection with any unauthorized modifications
422422
to any of its public licenses or any other arrangements,
423423
understandings, or agreements concerning use of licensed material. For
424-
the avoidance of doubt, this paragraph does not form part of the
425-
public licenses.
424+
the avoidance of doubt, this paragraph does not form part of the public
425+
licenses.
426426

427-
Creative Commons may be contacted at creativecommons.org.
427+
Creative Commons may be contacted at creativecommons.org.

README.md

+2-22
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,2 @@
1-
# Source for Skytable docs
2-
3-
This repository contains the source code for the documentation hosted [here](https://docs.skytable.io).
4-
5-
## Contributing
6-
7-
The entire documentation website is available for everyone to improve (and reuse!).
8-
9-
If you want to improve an existing page, the best way to do it: is to click the pencil icon on a page that you want to edit. This will take you to the respective file where you can add what you want!
10-
11-
### Steps
12-
13-
1. Fork the repository
14-
2. Head over to the `docs` folder and change what you need to!
15-
3. Create a pull request [here](https://github.com/skytable/docs/pulls)
16-
4. One of the maintainers will respond almost immediately and suggest changes if required (usually they aren't needed - we know you're awesome 😉)
17-
5. Once your changes are approved - it will be merged 🎉
18-
6. Done! Thank you ❤️!
19-
20-
## License
21-
22-
The entire documentation is licensed under the [CC-BY-SA-4.0 License](./LICENSE).
1+
# Skytable Documentation
2+
This is the future documentation site for Skytable.

babel.config.js

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
module.exports = {
2+
presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
3+
};

builddoc.sh

-1
This file was deleted.

deploy.sh

-16
This file was deleted.

docbuilder/Cargo.lock

-118
This file was deleted.

docbuilder/Cargo.toml

-10
This file was deleted.

docbuilder/src/main.rs

-92
This file was deleted.

docs/02-Actions.md

-20
This file was deleted.

docs/03-command-line-config.md

-9
This file was deleted.

0 commit comments

Comments
 (0)