{"id":19829693,"url":"https://github.com/dyalog/ride","last_synced_at":"2025-03-17T15:12:42.990Z","repository":{"id":19921458,"uuid":"23187520","full_name":"Dyalog/ride","owner":"Dyalog","description":"Remote IDE for Dyalog APL","archived":false,"fork":false,"pushed_at":"2024-03-03T16:49:55.000Z","size":25887,"stargazers_count":195,"open_issues_count":162,"forks_count":29,"subscribers_count":24,"default_branch":"master","last_synced_at":"2024-04-14T20:06:58.607Z","etag":null,"topics":["apl","cross-platform-ide","dyalog","dyalog-apl","ide","remote-access","remote-interpreter","ride"],"latest_commit_sha":null,"homepage":"https://dyalog.github.io/ride","language":"JavaScript","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/Dyalog.png","metadata":{"files":{"readme":"readme-docs.md","changelog":null,"contributing":null,"funding":null,"license":null,"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}},"created_at":"2014-08-21T13:10:53.000Z","updated_at":"2024-04-17T09:35:51.841Z","dependencies_parsed_at":"2023-02-10T09:15:48.195Z","dependency_job_id":"4d03d3bb-bbfc-49cc-9502-36da606a2235","html_url":"https://github.com/Dyalog/ride","commit_stats":null,"previous_names":[],"tags_count":89,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Dyalog%2Fride","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Dyalog%2Fride/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Dyalog%2Fride/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Dyalog%2Fride/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Dyalog","download_url":"https://codeload.github.com/Dyalog/ride/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244056425,"owners_count":20390719,"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":["apl","cross-platform-ide","dyalog","dyalog-apl","ide","remote-access","remote-interpreter","ride"],"created_at":"2024-11-12T11:19:41.799Z","updated_at":"2025-03-17T15:12:42.967Z","avatar_url":"https://github.com/Dyalog.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Building the docs\n\n## Pre-flight\n\nIf you're about to push out a new docs release, check the following first:\n\n1. Are the version statements in the \"installation.md\" page still valid? If the version of Electron has been bumped, this page must be checked.\n\n\n## Build process\n\nThe documentation for Ride lives at https://dyalog.github.io/ride. It is a GitHub Pages site, built with [mkdocs](https://www.mkdocs.org/), using the [material theme](https://squidfunk.github.io/mkdocs-material/).\n\nInstall the following components:\n\n1. [mkdocs](https://www.mkdocs.org/user-guide/installation/)\n2. [material theme](https://squidfunk.github.io/mkdocs-material/getting-started/)\n3. [mkdocs-print-site plugin](https://timvink.github.io/mkdocs-print-site-plugin/index.html)\n4. [mike](https://github.com/jimporter/mike)\n\n`mike` is a versioning plugin for `mkdocs`. It allows us to publish separate documentation sets on a per-version basis of Ride, and have a 'latest' alias.\n\nThe documentation source lives in the `docs/` directory, and consists primarily of markdown files. The file `mkdocs.yml` defines the layout of the documentation site. \n\nTo render the site locally, run\n\n```\nmike serve\n```\nThis should serve it up on http://localhost:8000/ by default.\n\nTo 'compile' your changes, run the command \n\n```\nmike deploy [version] # e.g. mike deploy 4.5\n```\n\nNote: this converts the markdown files etc to html, but doesn't serve, or indeed \"deploy\" the site. See the [docs](https://github.com/jimporter/mike/blob/master/README.md) for `mike` for the various commands that are available. \n\nIf you want to publish to live, add a `--push` to your `mike deploy` command. This commits and pushes the rendered files to your `gh-pages` branch.\n\nUse the command \n\n```\nmike set-default [version]\n```\nin order to configure the redirects, such that visitors to `.../ride` will be redirected to `.../ride/4.5/` (or whatever the default is set to).\n\nIt is possible to build the docs automatically using an Action. See how [Link](https://github.com/Dyalog/link/blob/master/.github/workflows/mkdocs-mike-deploy.yml) does this in case this becomes necessary.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdyalog%2Fride","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdyalog%2Fride","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdyalog%2Fride/lists"}