Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/xizon/uix-documentation
An HTML documentation tool, nothing more.
https://github.com/xizon/uix-documentation
documentation documentation-tool frontend html
Last synced: 1 day ago
JSON representation
An HTML documentation tool, nothing more.
- Host: GitHub
- URL: https://github.com/xizon/uix-documentation
- Owner: xizon
- License: mit
- Created: 2020-03-24T14:58:55.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-01-06T02:43:06.000Z (almost 2 years ago)
- Last Synced: 2023-08-12T07:39:18.604Z (over 1 year ago)
- Topics: documentation, documentation-tool, frontend, html
- Language: HTML
- Homepage: https://xizon.github.io/uix-documentation/examples/
- Size: 6.84 MB
- Stars: 5
- Watchers: 2
- Forks: 0
- Open Issues: 24
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Uix Documentation
## Installation And Test
You will need to have [node](https://nodejs.org/) setup on your machine. That will output the built distributables to `./dist/*` and `./examples/*.html`.
**Step 1.** Download the latest version from [Github](https://github.com/xizon/uix-documentation). For nodejs you have to install some dependencies.
```sh
$ git clone git://github.com/xizon/uix-documentation.git
```
**Step 2.** First, using an absolute path into your `"uix-documentation/"` folder directory.
```sh
$ cd /{your_directory}/uix-documentation
```
**Step 3.** Before doing all dev stuff make sure you have `Node 10+` installed. After that, run the following code in the main directory to install the node module dependencies.
```sh
$ sudo npm install --only=dev --unsafe-perm --production
```
**Step 4.** Run the following code to enter development mode. The converted ES5 files will be created.
```sh
$ npm run build
```
**Step 5.** When you done, this will spin up a server that can be accessed at
```sh
http://localhost:8080/examples/
```
### Note:
**ERROR: npm update check failed.**
```sh
$ sudo chown -R $USER:$(id -gn $USER) /Users/{username}/.config
```
* * *
## File Structures
```sh
uix-documentation/
├── README.md
├── LICENSE
├── webpack.config.js
├── package-lock.json
├── package.json
├── dist/
│ ├── css/
│ │ ├── app.css
│ │ ├── app.css.map
│ │ ├── app.min.css
│ │ └── app.min.css.map
│ └── js/
│ │ ├── app.js
│ │ ├── app.js.map
│ │ ├── app.min.js
│ │ └── app.min.js.map
├── src/
│ ├── index.js
│ ├── components/
├── examples/
└──
```
## Licensing
Licensed under the [MIT](https://opensource.org/licenses/MIT).