mirror of
https://github.com/pinry/pinry.git
synced 2025-11-17 02:10:39 +01:00
Adding new docs system
This commit is contained in:
1
docs/src/CNAME
Normal file
1
docs/src/CNAME
Normal file
@@ -0,0 +1 @@
|
||||
docs.getpinry.com
|
||||
4
docs/src/contributing.md
Normal file
4
docs/src/contributing.md
Normal file
@@ -0,0 +1,4 @@
|
||||
# Contributing
|
||||
|
||||
We welcome any and all types of contributions, even if it's just fixing a single
|
||||
small spelling mistake.
|
||||
8
docs/src/docs.md
Normal file
8
docs/src/docs.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# Docs
|
||||
|
||||
Timestrap's docs are built with `mkdocs`. If you have dev dependencies
|
||||
installed, `pipenv install --dev`, then you can use the following commands:
|
||||
|
||||
- `gulp docs:serve` for testing
|
||||
- `gulp docs:build` to build the files
|
||||
- `gulp docs:publish` to publish to github
|
||||
BIN
docs/src/imgs/screenshot.png
Normal file
BIN
docs/src/imgs/screenshot.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 2.5 MiB |
5
docs/src/index.md
Normal file
5
docs/src/index.md
Normal file
@@ -0,0 +1,5 @@
|
||||
# Pinry
|
||||
|
||||
The open-source core of Pinry, a tiling image board system for people who want
|
||||
to save, tag, and share images, videos and webpages in an easy to skim through
|
||||
format.
|
||||
27
docs/src/license.md
Normal file
27
docs/src/license.md
Normal file
@@ -0,0 +1,27 @@
|
||||
# License
|
||||
|
||||
## The BSD 2-Clause License
|
||||
|
||||
Copyright (c) `2019`, `Pinry's Contributors`
|
||||
All rights reserved.
|
||||
|
||||
Redistribution and use in source and binary forms, with or without modification,
|
||||
are permitted provided that the following conditions are met:
|
||||
|
||||
1. Redistributions of source code must retain the above copyright notice,
|
||||
this list of conditions and the following disclaimer.
|
||||
|
||||
2. Redistributions in binary form must reproduce the above copyright notice,
|
||||
this list of conditions and the following disclaimer in the documentation
|
||||
and/or other materials provided with the distribution.
|
||||
|
||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
|
||||
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
||||
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||||
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
|
||||
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
||||
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
||||
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
||||
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
||||
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
|
||||
THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
9
docs/src/screenshots.md
Normal file
9
docs/src/screenshots.md
Normal file
@@ -0,0 +1,9 @@
|
||||
# Screenshots
|
||||
|
||||
Due to the constant design iterations this is a very incomplete page. There
|
||||
will be more screenshots in the future. You could always try our demo that
|
||||
we mention on the first page of the docs.
|
||||
|
||||
## Timesheet
|
||||
|
||||

|
||||
Reference in New Issue
Block a user