Restructured docs

humhub · Nov 3, 2020 · 0f137b3 · 0f137b3
1 parent 2c004f2
commit 0f137b3
Show file tree

Hide file tree

Showing 4 changed files with 41 additions and 59 deletions.
diff --git a/docs/DEVELOPER.md b/docs/DEVELOPER.md
@@ -0,0 +1,4 @@
+# Developer
+
+Since CustomPages version v1.0 external modules can provide own targets through the **CustomPagesService**.
+
diff --git a/README.md → docs/MANUAL.md b/README.md → docs/MANUAL.md
@@ -1,53 +1,4 @@
-[![Build Status](https://travis-ci.org/humhub/humhub-modules-custom-pages.svg?branch=master)](https://travis-ci.org/humhub/humhub-modules-custom-pages)
-
-## Description
-
-The custom pages modules allows the creation of customized **pages** and **snippets** as well as on space
-global level. 
-
-Depending on content type and target the following content types are available:
-
-- MarkDown (HumHub Markdown Richtext based page)
-- Link (External link)
-- Iframe
-- Template
-- Html (Only available for global pages for security reasons)
-- PHP (requires further activation under `Administration -> Custom Pages -> Settings`)
-
-By default the module supports the following **targets** for global pages:
-
-- Top Navigation
-- User Account Menu (Account Settings)
-- Directory Menu
-- No Specific target (Direct link)
-
-and global Snippets:
-
-- Dashboard
-- Directory
-
-On space level the following page targets are supported by default:
-
-- Space Navigation
-
-and snippets:
-
-- Stream Sidebar
-
-Since v.1.0 external modules can provide own targets through the **CustomPagesService**.
-
-__Module website:__ <https://github.com/humhub/humhub-modules-custom-pages>    
-__Author:__ luke, buddh4    
-__Author website:__ [humhub.org](http://humhub.org)    
-
-
-## Changelog
-
-<https://github.com/humhub/humhub-modules-custom-pages/commits/master>
-
-## Bugtracker
-
-<https://github.com/humhub/humhub-modules-custom-pages/issues>
+# Manual
 
 ## Getting Started
 
@@ -153,12 +104,3 @@ Another container example with a figure and floating text based upon a **image**
 ```
 
 
-
-
-
-
-
-
-
-
-
diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1,35 @@
+# Custom Pages
+
+[![Build Status](https://travis-ci.org/humhub/humhub-modules-custom-pages.svg?branch=master)](https://travis-ci.org/humhub/humhub-modules-custom-pages)
+
+The custom pages modules allows the creation of customized **pages** and **snippets** (sidebar elements) as well as on space and on 
+global level. 
+
+Depending on content type and target the following content types are available:
+
+- MarkDown (HumHub Markdown Richtext based page)
+- Link (External link)
+- Iframe
+- Template
+- Html (Only available for global pages for security reasons)
+- PHP (requires further activation under `Administration -> Custom Pages -> Settings`)
+
+By default the module supports the following **targets** for global pages:
+
+- Top Navigation
+- User Account Menu (Account Settings)
+- Directory Menu
+- No Specific target (Direct link)
+
+and global Snippets:
+
+- Dashboard
+- Directory
+
+On space level the following page targets are supported by default:
+
+- Space Navigation
+
+and snippets:
+
+- Stream Sidebar
diff --git a/module.json b/module.json
@@ -4,6 +4,7 @@
     "description": "Allows admins to create custom pages (html or markdown) or external links to various navigations (e.g. top navigation, account menu).",
     "keywords": ["pages", "custom", "iframe", "markdown", "link", "navigation", "spaces"],
     "version": "1.1.0",
+    "homepage": "https://github.com/humhub/humhub-modules-custom-pages",
     "humhub": {
         "minVersion": "1.7"
     }