mirror of
https://github.com/sbrl/Pepperminty-Wiki.git
synced 2024-10-31 21:33:00 +00:00
Let's experiment with docpress.
This commit is contained in:
parent
d3ae8dda6a
commit
8983ce0aec
4 changed files with 7450 additions and 6 deletions
87
.gitignore
vendored
87
.gitignore
vendored
|
@ -1,3 +1,4 @@
|
||||||
|
_docpress/
|
||||||
# All wiki pages
|
# All wiki pages
|
||||||
*.md
|
*.md
|
||||||
# All the previous revisions
|
# All the previous revisions
|
||||||
|
@ -64,3 +65,89 @@ composer.phar
|
||||||
|
|
||||||
|
|
||||||
# End of https://www.gitignore.io/api/composer
|
# End of https://www.gitignore.io/api/composer
|
||||||
|
|
||||||
|
# Created by https://www.gitignore.io/api/node
|
||||||
|
# Edit at https://www.gitignore.io/?templates=node
|
||||||
|
|
||||||
|
### Node ###
|
||||||
|
# Logs
|
||||||
|
logs
|
||||||
|
*.log
|
||||||
|
npm-debug.log*
|
||||||
|
yarn-debug.log*
|
||||||
|
yarn-error.log*
|
||||||
|
|
||||||
|
# Runtime data
|
||||||
|
pids
|
||||||
|
*.pid
|
||||||
|
*.seed
|
||||||
|
*.pid.lock
|
||||||
|
|
||||||
|
# Directory for instrumented libs generated by jscoverage/JSCover
|
||||||
|
lib-cov
|
||||||
|
|
||||||
|
# Coverage directory used by tools like istanbul
|
||||||
|
coverage
|
||||||
|
|
||||||
|
# nyc test coverage
|
||||||
|
.nyc_output
|
||||||
|
|
||||||
|
# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
|
||||||
|
.grunt
|
||||||
|
|
||||||
|
# Bower dependency directory (https://bower.io/)
|
||||||
|
bower_components
|
||||||
|
|
||||||
|
# node-waf configuration
|
||||||
|
.lock-wscript
|
||||||
|
|
||||||
|
# Compiled binary addons (https://nodejs.org/api/addons.html)
|
||||||
|
build/Release
|
||||||
|
|
||||||
|
# Dependency directories
|
||||||
|
node_modules/
|
||||||
|
jspm_packages/
|
||||||
|
|
||||||
|
# TypeScript v1 declaration files
|
||||||
|
typings/
|
||||||
|
|
||||||
|
# Optional npm cache directory
|
||||||
|
.npm
|
||||||
|
|
||||||
|
# Optional eslint cache
|
||||||
|
.eslintcache
|
||||||
|
|
||||||
|
# Optional REPL history
|
||||||
|
.node_repl_history
|
||||||
|
|
||||||
|
# Output of 'npm pack'
|
||||||
|
*.tgz
|
||||||
|
|
||||||
|
# Yarn Integrity file
|
||||||
|
.yarn-integrity
|
||||||
|
|
||||||
|
# dotenv environment variables file
|
||||||
|
.env
|
||||||
|
|
||||||
|
# parcel-bundler cache (https://parceljs.org/)
|
||||||
|
.cache
|
||||||
|
|
||||||
|
# next.js build output
|
||||||
|
.next
|
||||||
|
|
||||||
|
# nuxt.js build output
|
||||||
|
.nuxt
|
||||||
|
|
||||||
|
# vuepress build output
|
||||||
|
.vuepress/dist
|
||||||
|
|
||||||
|
# Serverless directories
|
||||||
|
.serverless/
|
||||||
|
|
||||||
|
# FuseBox cache
|
||||||
|
.fusebox/
|
||||||
|
|
||||||
|
#DynamoDB Local files
|
||||||
|
.dynamodb/
|
||||||
|
|
||||||
|
# End of https://www.gitignore.io/api/node
|
||||||
|
|
12
README.md
12
README.md
|
@ -33,7 +33,7 @@ Developed by Starbeamrainbowlabs (though contributions from others are welcome!)
|
||||||
|
|
||||||
Above: The Main Page used for testing purposes.
|
Above: The Main Page used for testing purposes.
|
||||||
|
|
||||||
A live demo of the latest stable version can be found over at [my website](//starbeamrainbowlabs.com/labs/peppermint).
|
A live demo of the latest stable version can be found over at [my website](https://starbeamrainbowlabs.com/labs/peppermint).
|
||||||
|
|
||||||
More screenshots can be found in [this Imgur Album](https://imgur.com/a/lsBc3cM).
|
More screenshots can be found in [this Imgur Album](https://imgur.com/a/lsBc3cM).
|
||||||
|
|
||||||
|
@ -102,7 +102,7 @@ If you want a pre-built stable version, then you can [use the latest release](ht
|
||||||
If you're feeling lazy, you can grab the bleeding-edge version from this repository, which comes with all the latest modules. You can get it [here](https://raw.githubusercontent.com/sbrl/Pepperminty-Wiki/master/build/index.php).
|
If you're feeling lazy, you can grab the bleeding-edge version from this repository, which comes with all the latest modules. You can get it [here](https://raw.githubusercontent.com/sbrl/Pepperminty-Wiki/master/build/index.php).
|
||||||
|
|
||||||
#### Method 3: Using the online downloader
|
#### Method 3: Using the online downloader
|
||||||
Pepperminty Wiki has a downloader that you can use to select the modules you want to include in your install. The online downloader will give you the latest stable release. You can find it [here](//starbeamrainbowlabs.com/labs/peppermint/download.php).
|
Pepperminty Wiki has a downloader that you can use to select the modules you want to include in your install. The online downloader will give you the latest stable release. You can find it [here](https://starbeamrainbowlabs.com/labs/peppermint/download.php).
|
||||||
|
|
||||||
#### Method 3.5: Using the downloader offline
|
#### Method 3.5: Using the downloader offline
|
||||||
You can also you the downloader offline. Simply clone this repository to your web server and then point your web browser at `your.server/path/to/pepperminty/wiki/download.php`.
|
You can also you the downloader offline. Simply clone this repository to your web server and then point your web browser at `your.server/path/to/pepperminty/wiki/download.php`.
|
||||||
|
@ -129,7 +129,7 @@ These commands are also in `build.sh`. You can run that if you want. Here's an e
|
||||||
3. Actually builds Pepperminty Wiki. Outputs to `index.php`.
|
3. Actually builds Pepperminty Wiki. Outputs to `index.php`.
|
||||||
|
|
||||||
## Configuring
|
## Configuring
|
||||||
To configure your new install, make sure that you've loaded the wiki in your browser at least once. Then open `peppermint.json` in your favourite text editor. If you need any help, just contact me or [open an issue](//github.com/sbrl/Pepperminty-Wiki/issues/new).
|
To configure your new install, make sure that you've loaded the wiki in your browser at least once. Then open `peppermint.json` in your favourite text editor. If you need any help, just contact me or [open an issue](https://github.com/sbrl/Pepperminty-Wiki/issues/new).
|
||||||
|
|
||||||
~~Please note that configuration of Pepperminty Wiki will be done through a GUI soon.~~ _Most_ properties are now configurable in a graphical interface! It can be accessed through the _Edit Master Settings_ option in the more menu, or the `configure` action (e.g. `https://wiki.example.com/?action=configure`) if it doesn't appear for you.
|
~~Please note that configuration of Pepperminty Wiki will be done through a GUI soon.~~ _Most_ properties are now configurable in a graphical interface! It can be accessed through the _Edit Master Settings_ option in the more menu, or the `configure` action (e.g. `https://wiki.example.com/?action=configure`) if it doesn't appear for you.
|
||||||
|
|
||||||
|
@ -173,10 +173,10 @@ If you do create a module, I'd love to hear about it. Even better, [send a pull
|
||||||
- [PHP Module API](https://sbrl.github.io/Pepperminty-Wiki/docs/ModuleApi/)
|
- [PHP Module API](https://sbrl.github.io/Pepperminty-Wiki/docs/ModuleApi/)
|
||||||
|
|
||||||
## Real World Usage
|
## Real World Usage
|
||||||
None yet! Contact me or [open an issue](//github.com/sbrl/Pepperminty-Wiki/issues/new) and tell me about where you are using Pepperminty Wiki and I'll add you to this section :smiley_cat:
|
None yet! Contact me or [open an issue](https://github.com/sbrl/Pepperminty-Wiki/issues/new) and tell me about where you are using Pepperminty Wiki and I'll add you to this section :smiley_cat:
|
||||||
|
|
||||||
## Todo
|
## Todo
|
||||||
Here's a list of things that I want to add at some point (please feel free to [send a pull request](//github.com/sbrl/Pepperminty-Wiki/pulls) and help out!).
|
Here's a list of things that I want to add at some point (please feel free to [send a pull request](https://github.com/sbrl/Pepperminty-Wiki/pulls) and help out!).
|
||||||
|
|
||||||
- Better page history (revert to revision, compare revisions, etc.) (#78, #79)
|
- Better page history (revert to revision, compare revisions, etc.) (#78, #79)
|
||||||
- Intelligent auto-updating system that doesn't wipe your settings / module choices
|
- Intelligent auto-updating system that doesn't wipe your settings / module choices
|
||||||
|
@ -188,7 +188,7 @@ Here's a list of things that I want to add at some point (please feel free to [s
|
||||||
- (See more on the [issue tracker](https://github.com/sbrl/Pepperminty-Wiki/issues)!)
|
- (See more on the [issue tracker](https://github.com/sbrl/Pepperminty-Wiki/issues)!)
|
||||||
- ...?
|
- ...?
|
||||||
|
|
||||||
Is the feature you want to see not on this list or not implemented yet? [Open an issue](//github.com/sbrl/Pepperminty-Wiki/issues/new) or [send a pull request](//github.com/sbrl/Pepperminty-Wiki/pulls) - contributions welcome!
|
Is the feature you want to see not on this list or not implemented yet? [Open an issue](https://github.com/sbrl/Pepperminty-Wiki/issues/new) or [send a pull request](https://github.com/sbrl/Pepperminty-Wiki/pulls) - contributions welcome!
|
||||||
|
|
||||||
# License
|
# License
|
||||||
Pepperminty Wiki is released under the Mozilla Public License 2.0. The full license text is included in the `LICENSE` file in this repository.
|
Pepperminty Wiki is released under the Mozilla Public License 2.0. The full license text is included in the `LICENSE` file in this repository.
|
||||||
|
|
7332
package-lock.json
generated
Normal file
7332
package-lock.json
generated
Normal file
File diff suppressed because it is too large
Load diff
25
package.json
Normal file
25
package.json
Normal file
|
@ -0,0 +1,25 @@
|
||||||
|
{
|
||||||
|
"name": "pepperminty-wiki",
|
||||||
|
"version": "0.17.1",
|
||||||
|
"description": "A wiki in a box",
|
||||||
|
"main": "index.js",
|
||||||
|
"directories": {
|
||||||
|
"doc": "docs"
|
||||||
|
},
|
||||||
|
"scripts": {
|
||||||
|
"test": "echo \"Error: no test specified\" && exit 1"
|
||||||
|
},
|
||||||
|
"repository": {
|
||||||
|
"type": "git",
|
||||||
|
"url": "git+https://github.com/sbrl/Pepperminty-Wiki.git"
|
||||||
|
},
|
||||||
|
"author": "Starbeamrainbowlabs",
|
||||||
|
"license": "MPL-2.0",
|
||||||
|
"bugs": {
|
||||||
|
"url": "https://github.com/sbrl/Pepperminty-Wiki/issues"
|
||||||
|
},
|
||||||
|
"homepage": "https://github.com/sbrl/Pepperminty-Wiki#readme",
|
||||||
|
"devDependencies": {
|
||||||
|
"docpress": "^0.7.4"
|
||||||
|
}
|
||||||
|
}
|
Loading…
Reference in a new issue