Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/vantagedesign/ace-documentation.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJulian <julian@vantage-design.com>2020-02-06 23:20:17 +0300
committerJulian <julian@vantage-design.com>2020-02-06 23:20:17 +0300
commit5ebb0ab1e5106bdfcafd5b459d466e16a59b6b01 (patch)
tree8bef96f8c1030cdf872d80d55ec11b2f25360497 /README.md
First commit
Diffstat (limited to 'README.md')
-rw-r--r--README.md70
1 files changed, 70 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..4bdc27e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,70 @@
+# [Ace documentation](https://docs.vantage-design.com/ace)
+
+![Product thumbnail](https://github.com/vantagedesign/assets/blob/master/ace-documentation/ace-thumbnail-shadow.png)
+
+Create beautiful documentation for your projects with Ace for Hugo. Powered by Bootstrap and SASS, featuring must-have features such as syntax highlighting, copy-able code blocks, full search, a responsive layout and the power of Markdown to create your content.
+
+Writing documentation has never been so easy.
+
+### Rich in features
+Ace offers a variety of custom components and features which are a must-have for building project documentation. Code blocks are enriched with syntax highlighting and a copy button, allowing for your users to easily read your code and copy it into their project. Furthermore, a special version of the code block renders the HTML content in both the code block and on the page, giving your users a preview of what the code looks like.
+
+Other shortcodes allow you to use Bootstrap components in your content, such as alerts, buttons, panels, collapse elements and more.
+
+Full search allows your users to quickly find the content they require, and a responsive design makes your documentation available on both desktop and mobile devices.
+
+### Beautiful minimalist design
+With a minimal design, the attention of users is focused on that which matters: your content.
+
+
+
+## Demo & documentation
+The documentation for Ace was, of course, built with Ace. Therefore, the documentation for Ace also serves as a demo.
+[Ace demo & documentation](https://docs.vantage-design.com/ace)
+
+
+
+## Installation
+
+- [Download from GitHub](https://github.com/vantagedesign/ace-documentation/releases)
+- Clone the repo `git clone https://github.com/vantagedesign/ace-documentation.git`
+
+*Note:* this theem only works with Hugo's extended version, due to the SCSS compile functionality.
+
+
+## Resources
+
+- [Store page](https://vantage-design.com/products/documentation-themes/4/ace-documentation)
+- [Demo](https://docs.vantage-design.com/ace)
+- [Documentation](https://docs.vantage-design.com/ace)
+- [Issues](https://github.com/vantagedesign/ace-documentation/issues)
+- [License](https://github.com/vantagedesign/ace-documentation/glob/master/LICENSE)
+
+
+## Reporting Issues
+
+We use GitHub Issues as the official bug tracker for the Ace documentation. When reporting an issue, please follow the following guidelines:
+
+1. Make sure that you are using the latest version of Ace documentation.
+2. Provide us with reproducible steps for recreating the issue, in order for us to find the issue and fix is as soon as possible.
+3. Specify your browser and version of Ace.
+
+
+## Licensing
+
+- Copyright 2020 [Vantage Design](https://vantage-design.com)
+- Licensed under MIT (https://github.com/vantagedesign/ace-documentation/glob/master/LICENSE)
+
+## Useful links
+
+- [More products](https://vantage-design.com)
+- [Free products](https://vantage-design.com/products/free-products/)
+- [Premium products](https://vantage-design.com/products/premium-products/)
+- [Design sytems](https://vantage-design.com/products/design-systems/)
+- [Page templates](https://vantage-design.com/products/page-templates/)
+- [Documentation themes](https://vantage-design.com/products/documentation-themes/)
+
+### Social Media
+
+- Facebook: <https://www.facebook.com/vantagedesignofficial>
+- Instagram: <https://www.instagram.com/vantagedesignofficial> \ No newline at end of file