Skip to content
Zumasys Product Documentation
JavaScript Vue CSS
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
site
.gitignore
LICENSE
README.md

README.md

Zumasys Documentation

This is a VuePress documentation application that leverages GitHub as the repository of documentation. The repository is currently hosted in the Zumasys GitHub and the app is available at Zumasys BetaDocs. The documentation was created by way of HelpJuice-to-Markdown.

Directory structure

├── site
│   ├── .vuepress
│   │   ├── components
│   │   ├── theme
│   │   ├── public
│   │   ├── styles
│   │   │   ├── index.styl
│   │   │   └── palette.styl
│   │   ├── config.js
│   ├── docs
│   │   ├── jbase (Note: jBASE documentation lives here)
│   │   ├── zumasys (Note: Zumasys documentation lives here)
│   │   └── README.md
│   ├── README.md (Note: The home page of the docs)
│   └── package.json
└── README.md (Note: You are here!)

Development Steps

To run the application locally:

You will need to have Node.js & npm installed. You'll also need Git.

  1. git clone https://github.com/zumasys/docs.git

  2. cd docs (or whatever name you used for your git clone)

  3. cd site

  4. npm install (Not necessary on subsequent builds)

  5. npm run dev

  6. When compilation completes you should see the following message

    success [12:25:41] Build 59cc58 finished in 75022 ms!
    VuePress dev server listening at http://localhost:8080/

  7. Open localhost:8080 in your browser.

TODO - Contributor Guidelines

TODO - Community Guidelines

TODO - Contributors

Todo List

  • Add sidebar links matching docs directory structure
  • Clean up directory structure under the Zumasys folder (i.e. AccuTerm folder -> Mobile and Web)
  • Clean up root directory (move docs project into sub-dir)
  • Add Table of Contents
  • More config
  • More theme config
  • More customization
  • Pull images from HelpJuice into static assets of this project and update links
  • Add Vssue plugin for comments
  • Add breadcrumbs/navigation trail to docs layout (not seeing a plugin or config for this so we'll do it in Vue)
  • Add Google Analytics plugin or the minimal version
  • Add Clean URLs plugin (may not be necessary with current directory/README.md structure)
  • Add Git Log plugin (to add Git data to $page object)
  • Add Algolia Search plugin (more docs)
  • Add nprogress plugin (to show global page loading bar)
  • Add reading progress plugin (to show reading progress of a document)
  • Add TypeScript plugin (to allow use of TypeScript in VuePress .vue files)
  • Add check-md plugin (to check for dead links in Markdown)
  • Add flowchart plugin (to define flowcharts in docs)
  • Add export plugin (to allow for export of all docs to PDF)
  • Add sitemap plugin (to allow for auto creation of sitemap.xml file)
  • Add SEO plugin (for automatic SEO meta tag generation)
  • Related to above, may also need autometa plugin
  • Add reading time plugin (to show etsimated reading time for an article)
  • Add social share plugin (to activate social network share icons)
  • Add code copy plugin (to allow for click-to-copy of source code)
  • Add img lazy plugin (to add lazy loading for images)
  • Add back to top plugin (for automatic back-to-top links)
  • Check out more on awesome-vuepress
  • Convert TODOs to GitHub Issues
  • Add jBASE Basic, Jabba to Prism
You can’t perform that action at this time.