Ably Docs

This repository is the source for content published to https://ably.com/docs.

The source content is written in Textile and the site is generated by Gatsby.

Run locally

To run the docs site locally, follow these steps:

Clone this repository and make it your working directory.
Run yarn install to install all dependencies.
If this is the first time running the site, run yarn run develop:env-setup to setup your environment variables. Visit localhost:8000 to view the site.
Run yarn run develop and visit localhost:8000 to view the site.

View the contribution guide for information on how to write content and contribute to Ably docs.

If you have any questions or suggestions, please raise an issue.

The Website app forwards requests to /docs to the docs.ably.com site.

Asset prefixing is applied only during the app build process and is not available in the dev version.

To ensure proper setup in your local:

Set the ASSET_PREFIX=http://localhost:9000 variable in your environment.
Add DOCS_BASE_URL=http://localhost:9000 to your .env file in the root of the Website app.
Ensure that .env.production exists in the app root for the Yarn build to function correctly.
You should be able to view the content and toggle between signed in and signed-out states.

Name		Name	Last commit message	Last commit date
Latest commit History 7,093 Commits
.circleci		.circleci
.githooks		.githooks
.github		.github
__fixtures__		__fixtures__
__mocks__		__mocks__
bin		bin
config		config
content		content
data		data
environment-management		environment-management
examples		examples
how-tos/pub-sub		how-tos/pub-sub
mocks		mocks
src		src
static		static
test-generators.js		test-generators.js
.editorconfig		.editorconfig
.env.example		.env.example
.eslintrc.json		.eslintrc.json
.gitignore		.gitignore
.prettierrc		.prettierrc
.slugignore		.slugignore
.tool-versions		.tool-versions
CONTRIBUTING.md		CONTRIBUTING.md
COPYRIGHT		COPYRIGHT
LICENSE		LICENSE
MAINTAINERS.md		MAINTAINERS.md
Procfile		Procfile
README.md		README.md
app.json		app.json
babel.config.js		babel.config.js
gatsby-browser.tsx		gatsby-browser.tsx
gatsby-config.ts		gatsby-config.ts
gatsby-node.ts		gatsby-node.ts
gatsby-overwrite-config.ts		gatsby-overwrite-config.ts
gatsby-ssr.tsx		gatsby-ssr.tsx
index.textile		index.textile
jest-environment-patched-jsdom.js		jest-environment-patched-jsdom.js
jest-preprocess.js		jest-preprocess.js
jest.config.js		jest.config.js
jest.polyfills.js		jest.polyfills.js
loadershim.js		loadershim.js
package.json		package.json
postcss.config.js		postcss.config.js
read-textile.ts		read-textile.ts
setupTests.js		setupTests.js
static.json		static.json
tailwind.config.js		tailwind.config.js
tsconfig.json		tsconfig.json
writing-style-guide.md		writing-style-guide.md
yarn.lock		yarn.lock