{"id":27395739,"url":"https://github.com/starknet-io/starknet-docs-ui","last_synced_at":"2025-04-13T23:25:18.848Z","repository":{"id":182259814,"uuid":"630052575","full_name":"starknet-io/starknet-docs-ui","owner":"starknet-io","description":"The Antora UI project used by Starknet docs (docs.starknet.io).","archived":false,"fork":false,"pushed_at":"2025-04-11T13:15:55.000Z","size":33133,"stargazers_count":12,"open_issues_count":0,"forks_count":15,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-11T14:15:19.209Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"CSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/starknet-io.png","metadata":{"files":{"readme":"README.adoc","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2023-04-19T15:08:09.000Z","updated_at":"2025-04-11T13:15:58.000Z","dependencies_parsed_at":null,"dependency_job_id":"0e496dc8-6157-466f-a148-489d4cf2a969","html_url":"https://github.com/starknet-io/starknet-docs-ui","commit_stats":null,"previous_names":["starknet-io/starknet-docs-antora-ui","starknet-io/starknet-docs-ui"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/starknet-io%2Fstarknet-docs-ui","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/starknet-io%2Fstarknet-docs-ui/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/starknet-io%2Fstarknet-docs-ui/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/starknet-io%2Fstarknet-docs-ui/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/starknet-io","download_url":"https://codeload.github.com/starknet-io/starknet-docs-ui/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248795353,"owners_count":21162755,"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":[],"created_at":"2025-04-13T23:25:18.194Z","updated_at":"2025-04-13T23:25:18.829Z","avatar_url":"https://github.com/starknet-io.png","language":"CSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"// External URLs:\n:url-antora: https://antora.org\n:url-antora-docs: https://docs.antora.org\n:url-git: https://git-scm.com\n:url-git-dl: {url-git}/downloads\n:url-gulp: http://gulpjs.com\n:url-opendevise: https://opendevise.com\n:url-nodejs: https://nodejs.org\n:url-nvm: https://github.com/creationix/nvm\n:url-nvm-install: {url-nvm}#installation\n:url-source-maps: https://developer.mozilla.org/en-US/docs/Tools/Debugger/How_to/Use_a_source_map\n\n= Starknet Docs UI repository\n\nWelcome to the https://docs.starknet.io[Starknet Docs^] UI repository, written in https://handlebarsjs.com/[Handlebars^] and built using https://gulpjs.com/[Gulp^].\n\n[NOTE]\n====\nThis repository only contains the UI of the Starknet Docs. For the content, see the https://github.com/starknet-io/starknet-docs/tree/main[Starknet Docs repository^].\n====\n\n== Prerequisites\n\nTo preview and bundle the UI, you need the following software on your computer:\n\n* {url-git}[git] (command: `git`)\n* {url-nodejs}[Node.js] (commands: `node` and `npm`)\n* {url-gulp}[Gulp CLI] (command: `gulp`)\n\n=== git\n\nFirst, make sure you have git installed.\n\n $ git --version\n\nIf not, {url-git-dl}[download and install] the git package for your system.\n\n=== Node.js\n\nNext, make sure that you have Node.js installed (which also provides npm).\n\n $ node --version\n\nIf this command fails with an error, you don't have Node.js installed.\nIf the command doesn't report an LTS version of Node.js (e.g., v10.15.3), it means you don't have a suitable version of Node.js installed.\nIn this guide, we'll be installing Node.js 10.\n\nWhile you can install Node.js from the official packages, we strongly recommend that you use {url-nvm}[nvm] (Node Version Manager) to manage your Node.js installation(s).\nFollow the {url-nvm-install}[nvm installation instructions] to set up nvm on your machine.\n\nOnce you've installed nvm, open a new terminal and install Node.js 10 using the following command:\n\n $ nvm install 10\n\nYou can switch to this version of Node.js at any time using the following command:\n\n $ nvm use 10\n\nTo make Node.js 10 the default in new terminals, type:\n\n $ nvm alias default 10\n\nNow that you have Node.js installed, you can proceed with installing the Gulp CLI.\n\n=== Gulp CLI\n\nYou'll need the Gulp command-line interface (CLI) to run the build.\nThe Gulp CLI package provides the `gulp` command which, in turn, executes the version of Gulp declared by the project.\n\nYou can install the Gulp CLI globally (which resolves to a location in your user directory if you're using nvm) using the following command:\n\n $ npm install -g gulp-cli\n\nVerify the Gulp CLI is installed and on your PATH by running:\n\n $ gulp --version\n\nIf you prefer to install global packages using Yarn, run this command instead:\n\n $ yarn global add gulp-cli\n\nAlternatively, you can use the `gulp` command that is installed by the project's dependencies.\n\n $ (npm bin)/gulp --version\n\nFor example:\n\n $ ~/.yarn/bin/gulp --version\n\nNow that you have the prerequisites installed, you can fetch and build the UI project.\n\n== Clone and Initialize the UI Project\n\nClone the UI project using git:\n\n[subs=attributes+]\n----\n$ git clone https://github.com/starknet-io/starknet-docs.git \u0026\u0026 cd \"`basename $_`\"\n----\n\nThe example above clones the UI project and then switches to the project folder on your filesystem.\nStay in this project folder when executing all subsequent commands.\n\nUse npm to install the project's dependencies inside the project.\nIn your terminal, execute the following command:\n\n $ npm install\n\nThis command installs the dependencies listed in [.path]_package.json_ into the [.path]_node_modules/_ folder inside the project.\nThis folder is not included in the UI bundle and should _not_ be committed to the source control repository.\n\n[TIP]\n====\nIf you prefer to install packages using Yarn, run this command instead:\n\n $ yarn\n====\n\n== Preview the UI\n\nThe UI project is configured to preview offline.\nThe files in the [.path]_preview-src/_ folder provide the sample content that allows you to see the UI in action.\nIn this folder, you'll primarily find pages written in AsciiDoc.\nThese pages provide a representative sample and kitchen sink of content from the real site.\n\nTo build the UI and preview it in a local web server, run the `preview` command:\n\n $ gulp preview\n\nOr\n\n $ ~/.yarn/bin/gulp preview\n\nYou'll see a URL listed in the output of this command:\n\n....\n[12:00:00] Starting server...\n[12:00:00] Server started http://localhost:5252\n[12:00:00] Running server\n....\n\nNavigate to this URL to preview the site locally.\n\nWhile this command is running, any changes you make to the source files will be instantly reflected in the browser.\nThis works by monitoring the project for changes, running the `preview:build` task if a change is detected, and sending the updates to the browser.\n\nPress kbd:[Ctrl+C] to stop the preview server and end the continuous build.\n\n== Package for Use with Antora\n\nIf you need to package the UI so you can use it to generate the documentation site locally, run the following command:\n\n $ gulp bundle\n\nIf any errors are reported by lint, you'll need to fix them.\n\nWhen the command completes successfully, the UI bundle will be available at [.path]_build/ui-bundle.zip_.\nYou can point Antora at this bundle using the `--ui-bundle-url` command-line option.\n\nIf you have the preview running, and you want to bundle without causing the preview to be clobbered, use:\n\n $ gulp bundle:pack\n\nor\n\n $ yarn build\n\nThe UI bundle will again be available at [.path]_build/ui-bundle.zip_.\n\n=== Source Maps\n\nThe build consolidates all the CSS and client-side JavaScript into combined files, [.path]_site.css_ and [.path]_site.js_, respectively, in order to reduce the size of the bundle.\n{url-source-maps}[Source maps] correlate these combined files with their original sources.\n\nThis \"`source mapping`\" is accomplished by generating additional map files that make this association.\nThese map files sit adjacent to the combined files in the build folder.\nThe mapping they provide allows the debugger to present the original source rather than the obfuscated file, an essential tool for debugging.\n\nIn preview mode, source maps are enabled automatically, so there's nothing you have to do to make use of them.\nIf you need to include source maps in the bundle, you can do so by setting the `SOURCEMAPS` environment variable to `true` when you run the bundle command:\n\n $ SOURCEMAPS=true gulp bundle\n\nIn this case, the bundle will include the source maps, which can be used for debugging your production site.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstarknet-io%2Fstarknet-docs-ui","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstarknet-io%2Fstarknet-docs-ui","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstarknet-io%2Fstarknet-docs-ui/lists"}