The Okta developer site serves Okta's API documentation and guides, including:
- API references
- SDK references and sample code
- Authentication quickstarts
- Guides
- Developer Blog (not published from this repo, see okta/okta.github.io)
Okta's developer documentation (this repo) is built using the VuePress site generator. There are currently 2 parts to the site, the content and the theming/plugins.
We recommend using one of the package manager options for installation as specified in the installation sites.
Before getting started, open a terminal window and make sure these commands work:
node --version
yarn --version- Clone the repo (use the Clone or download button above)
- Install the dependencies with
yarn:
cd okta-developer-docs
yarn installThis will install everything you need to build the documentation on your machine.
With the above steps completed, you can start a preview server by running this command inside the cloned directory:
yarn devThis starts a preview server on your machine, and watches all files for changes. Open http://localhost:8080/docs/ to view the documentation.
Note: if you try to visit the root, you will get a 404 page. You must visit a path corresponding to a directory under
vuepress-site, like/docs/.
The preview server supports hot reloading. Once the server is running on your machine, any changes you make to Markdown content will appear automatically in your browser within a few seconds. Note that changes to page frontmatter or site configuration require you to stop and start the preview server.
Links:
- Developer docs: https://developer.okta.com
- Developer forum: https://devforum.okta.com
- VuePress software: https://vuepress.vuejs.org
See our updated wiki for full details on contributing to the developer documentation repo: