{"id":20314795,"url":"https://github.com/xizon/uix-documentation","last_synced_at":"2025-10-29T23:40:12.609Z","repository":{"id":39183802,"uuid":"249737865","full_name":"xizon/uix-documentation","owner":"xizon","description":"An HTML documentation tool, nothing more.","archived":false,"fork":false,"pushed_at":"2023-01-06T02:43:06.000Z","size":7171,"stargazers_count":5,"open_issues_count":24,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-01-14T12:50:00.890Z","etag":null,"topics":["documentation","documentation-tool","frontend","html"],"latest_commit_sha":null,"homepage":"https://xizon.github.io/uix-documentation/examples/","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/xizon.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-03-24T14:58:55.000Z","updated_at":"2023-03-08T10:30:14.000Z","dependencies_parsed_at":"2023-02-05T03:30:52.691Z","dependency_job_id":null,"html_url":"https://github.com/xizon/uix-documentation","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xizon%2Fuix-documentation","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xizon%2Fuix-documentation/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xizon%2Fuix-documentation/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xizon%2Fuix-documentation/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/xizon","download_url":"https://codeload.github.com/xizon/uix-documentation/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241818878,"owners_count":20025210,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["documentation","documentation-tool","frontend","html"],"created_at":"2024-11-14T18:16:44.595Z","updated_at":"2025-10-29T23:40:12.562Z","avatar_url":"https://github.com/xizon.png","language":"HTML","readme":"# Uix Documentation\n\n\n## Installation And Test\n\nYou will need to have [node](https://nodejs.org/) setup on your machine. That will output the built distributables to `./dist/*` and `./examples/*.html`.\n\n\n\n**Step 1.** Download the latest version from [Github](https://github.com/xizon/uix-documentation). For nodejs you have to install some dependencies.\n\n```sh\n$ git clone git://github.com/xizon/uix-documentation.git\n```\n\n\n**Step 2.** First, using an absolute path into your `\"uix-documentation/\"` folder directory.\n\n```sh\n$ cd /{your_directory}/uix-documentation\n```\n\n\n**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.\n\n```sh\n$ sudo npm install --only=dev --unsafe-perm --production\n```\n\n\n**Step 4.** Run the following code to enter development mode. The converted ES5 files will be created.\n\n```sh\n$ npm run build\n```\n\n**Step 5.** When you done, this will spin up a server that can be accessed at\n\n```sh\nhttp://localhost:8080/examples/\n```\n\n\n### Note:\n \n**ERROR: npm update check failed.**\n\n```sh\n$ sudo chown -R $USER:$(id -gn $USER) /Users/{username}/.config\n```\n\n\n\n* * *\n\n\n## File Structures\n\n\n\n```sh\n\nuix-documentation/\n├── README.md\n├── LICENSE\n├── webpack.config.js\n├── package-lock.json\n├── package.json\n├── dist/\n│   ├── css/\n│   │   ├── app.css\n│   │   ├── app.css.map\n│   │   ├── app.min.css\n│   │   └── app.min.css.map\n│   └── js/\n│   │   ├── app.js\n│   │   ├── app.js.map\n│   │   ├── app.min.js\n│   │   └── app.min.js.map\n├── src/\n│   ├── index.js\n│   ├── components/\n├── examples/\n└──\n```\n\n\n\n## Licensing\n\nLicensed under the [MIT](https://opensource.org/licenses/MIT).\n\n\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxizon%2Fuix-documentation","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fxizon%2Fuix-documentation","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxizon%2Fuix-documentation/lists"}