docs: generate doc from specs #92
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| [build] | ||
| command="yarn website:build" | ||
| publish="website/build" | ||
| ignore="git diff --quiet $COMMIT_REF $CACHED_COMMIT_REF -- website/ specs/bundled/" | ||
|
|
||
| [build.environment] | ||
| YARN_VERSION = "3.1.1" |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| # Dependencies | ||
| /node_modules | ||
|
|
||
| # Production | ||
| /build | ||
|
|
||
| # Generated files | ||
| .docusaurus | ||
| .cache-loader | ||
|
|
||
| # Misc | ||
| .DS_Store | ||
| .env.local | ||
| .env.development.local | ||
| .env.test.local | ||
| .env.production.local | ||
|
|
||
| npm-debug.log* | ||
| yarn-debug.log* | ||
| yarn-error.log* |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| # Website | ||
|
|
||
| This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator. | ||
|
|
||
| ### Installation | ||
|
|
||
| ``` | ||
| $ yarn | ||
| ``` | ||
|
|
||
| ### Local Development | ||
|
|
||
| ``` | ||
| $ yarn start | ||
| ``` | ||
|
|
||
| This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server. | ||
|
|
||
| ### Build | ||
|
|
||
| ``` | ||
| $ yarn build | ||
| ``` | ||
|
|
||
| This command generates static content into the `build` directory and can be served using any static contents hosting service. | ||
|
|
||
| ### Deployment | ||
|
|
||
| Using SSH: | ||
|
|
||
| ``` | ||
| $ USE_SSH=true yarn deploy | ||
| ``` | ||
|
|
||
| Not using SSH: | ||
|
|
||
| ``` | ||
| $ GIT_USER=<Your GitHub username> yarn deploy | ||
| ``` | ||
|
|
||
| If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| // eslint-disable-next-line import/no-commonjs | ||
| module.exports = { | ||
| presets: [require.resolve('@docusaurus/core/lib/babel/preset')], | ||
| }; |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| --- | ||
| title: Generation commands | ||
| --- | ||
|
|
||
| # CLI generation commands | ||
|
|
||
| ## Usage | ||
|
|
||
| ```bash | ||
| yarn docker generate <language | all> <client | all> | ||
| ``` | ||
|
|
||
| ### Available options | ||
|
|
||
| | Option | Command | Description | | ||
| | ----------- | :---------------- | :------------------------------------------------------------ | | ||
| | verbose | -v, --verbose | Make the process verbose, display logs from third party tools | | ||
| | interactive | -i, --interactive | Open prompt to query parameters | | ||
|
|
||
| ## Generate all clients for all support languages | ||
|
|
||
| ```bash | ||
| yarn docker generate | ||
| ``` | ||
|
|
||
| ### Generate specific client for specific language | ||
|
|
||
| ```bash | ||
| yarn docker generate java sources | ||
| ``` | ||
|
|
||
| ## Build all clients for all support languages | ||
|
|
||
| ```bash | ||
| yarn docker build clients | ||
| ``` | ||
|
|
||
| ### Build specific client for specific language | ||
|
|
||
| ```bash | ||
| yarn docker build clients javascript recommend | ||
| ``` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,97 @@ | ||
| --- | ||
| title: Getting started | ||
| --- | ||
|
|
||
| import Tabs from '@theme/Tabs'; | ||
| import TabItem from '@theme/TabItem'; | ||
|
|
||
| <Tabs | ||
| groupId="language" | ||
| defaultValue="js" | ||
| values={[ | ||
| { label: 'JavaScript', value: 'js', } | ||
| ] | ||
| }> | ||
| <TabItem value="js"> | ||
|
|
||
| ## Installation | ||
|
|
||
| To get started, you first need to install `algoliasearch` (or any other available API client package) | ||
|
|
||
| ```bash | ||
| yarn add @experimental-api-clients-automation/algoliasearch | ||
| ``` | ||
|
|
||
| Or use a specific package to reduce bundle size: | ||
|
|
||
| ```bash | ||
| yarn add @experimental-api-clients-automation/client-search | ||
| ``` | ||
|
|
||
| You can find the full list of available packages [here](https://www.npmjs.com/org/experimental-api-clients-automation). | ||
|
|
||
| ### Without a package manager | ||
|
|
||
| Add the JavaScript to your `<head>` | ||
|
|
||
| ```html | ||
| <script src="https://cdn.jsdelivr.net/npm/@experimental-api-clients-automation/[email protected]/dist/algoliasearch.umd.browser.js"></script> | ||
| ``` | ||
|
|
||
| ## Using the client | ||
|
|
||
| Then you need to import the correct package, depending on your choice: | ||
|
|
||
| ```js | ||
| import { algoliasearch } from 'algoliasearch'; | ||
|
|
||
| const client = algoliasearch(appId, apiKey); | ||
|
|
||
| // And access analytics or personalization client | ||
| const analyticsClient = client.initAnalytics(analyticsAppId, analyticsApiKey); | ||
| const personalizationCilent = client.initPersonalization(personalizationAppId, personalizationApiKey, 'eu'); | ||
| ``` | ||
|
|
||
| ```js | ||
| import { searchApi } from '@algolia/client-search'; | ||
|
|
||
| const client = searchApi(appId, apiKey); | ||
| ``` | ||
|
|
||
| It is possible to customize the client by passing optional parameters: | ||
|
|
||
| ```js | ||
| const client = searchApi(appId, apiKey, { | ||
| requester: customRequester(), | ||
| hosts: [{ | ||
| url: 'my.custom.host.net', | ||
| accept: 'read', | ||
| protocol: 'https', | ||
| }] | ||
| }) | ||
| ``` | ||
|
|
||
| Once the client is setup, you can enjoy all of Algolia API ! | ||
|
|
||
| ```js | ||
| const res = await client.search({ | ||
| indexName: 'my-index', | ||
| searchParams: { query: 'words to query' }, | ||
| }); | ||
|
|
||
| console.log('Search result', res.hits); | ||
| ``` | ||
|
|
||
|
|
||
| Or with the `personalization` client | ||
|
|
||
| ```js | ||
| const res = await personalizationCilent.getUserTokenProfile({ | ||
| userToken: 'token', | ||
| }); | ||
|
|
||
| console.log('User scores', res.scores); | ||
| ``` | ||
|
|
||
| </TabItem> | ||
| </Tabs> |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you rename website to something more specific like
documentationordocWebsite?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's the usual name of the folder for open-source repository that hosts their website on the same repository, but we can go with
documentationindeed