{"id":18417389,"url":"https://github.com/stellar/stellar-docs","last_synced_at":"2025-04-12T22:27:43.027Z","repository":{"id":53180093,"uuid":"521307729","full_name":"stellar/stellar-docs","owner":"stellar","description":"Documentation for Stellar","archived":false,"fork":false,"pushed_at":"2025-04-10T20:35:21.000Z","size":66751,"stargazers_count":81,"open_issues_count":59,"forks_count":167,"subscribers_count":26,"default_branch":"main","last_synced_at":"2025-04-10T20:49:04.687Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://developers.stellar.org","language":"MDX","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/stellar.png","metadata":{"files":{"readme":"README.md","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}},"created_at":"2022-08-04T14:54:27.000Z","updated_at":"2025-04-10T20:35:24.000Z","dependencies_parsed_at":"2023-02-12T05:16:51.175Z","dependency_job_id":"62331b4f-fe48-4972-a5a7-882637dde301","html_url":"https://github.com/stellar/stellar-docs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stellar%2Fstellar-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stellar%2Fstellar-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stellar%2Fstellar-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stellar%2Fstellar-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/stellar","download_url":"https://codeload.github.com/stellar/stellar-docs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248639180,"owners_count":21137794,"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":"2024-11-06T04:09:15.419Z","updated_at":"2025-04-12T22:27:42.994Z","avatar_url":"https://github.com/stellar.png","language":"MDX","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Stellar Documentation and API Reference 🌌 \u003c!-- omit in toc --\u003e\n\nWelcome to the official home repository for [Documentation][docs] for the [Stellar network][stellar].\n\n## Table of Contents \u003c!-- omit in toc --\u003e\n\n- [Contributing](#contributing)\n- [Quick Start](#quick-start)\n  - [Prerequisites](#prerequisites)\n  - [Development](#development)\n- [Repository Structure](#repository-structure)\n- [Using Markdown](#using-markdown)\n  - [Markdown Basics](#markdown-basics)\n  - [Custom Markdown](#custom-markdown)\n    - [Alert](#alert)\n    - [Code Example](#code-example)\n\n## Contributing\n\nContributions are more than welcome! Thank you! 🎉\n\nBefore diving in, please read our [Stellar Contribution Guide][contrib] for\ndetails on contributing to Stellar's various repositories. Please take special\nnote of the [code of conduct][coc].\n\nOur documentation site is built using [Docusaurus][docusaurus]. The content is\nwritten in [MDX][mdx], which adds a lot of cool possibilities. Even if you're\nunfamiliar with plain markdown, do not fear! You can still contribute in a\nhelpful and meaningful way. Markdown is super easy to learn, and will come quite\nnaturally after only a bit of practice. You can always help fix typos, spelling,\nand broken links, too.\n\nYou can contribute to the docs in several ways:\n\n- See something that needs to be fixed in the docs, like an error in the code or a typo? File a [pull request (PR)](https://github.com/stellar/stellar-docs/pulls) proposing to correct the error;\n- Think there is helpful content missing from the docs, like a specific how-to guide or piece of explanatory content? File an [issue](https://github.com/stellar/stellar-docs/issues) explaining what you’d like to see (be sure to search existing issues to avoid duplication);\n- Have an idea that could make the docs better, like a structural change or a new section idea? File an [issue](https://github.com/stellar/stellar-docs/issues) explaining what you’d like to see (these will be added to the Ideas section on the [Dev Docs board](https://github.com/orgs/stellar/projects/56/views/1) for discussion);\n- Want to complete an existing issue? Search through the issues to find something to work on! Issues without an assignee and labeled as a “Good First Issue” or with “Help Wanted” are great places to start! Once you’ve selected an issue to work on, file a PR with your proposed fix.\n\nNo matter what you contribute, whether a PR or an issue, you can expect to receive a response from docs maintainers within one week.\n\n- PRs need to be reviewed and approved before merging. Look for either an approval or a follow-up question.\n- Issues will be prioritized, labeled, and assigned (if possible). You can check the status of your issue on the Dev Docs board. The status of issues according to the column is:\n  - Ideas: these issues are being actively discussed. Ideas will either be discarded or repurposed into an actionable issue and added to the queue within three weeks.\n  - Backlog: these issues are not prioritized or actively being worked on.\n  - To Do: these issues are prioritized and will be worked on soon.\n  - In Progress: these issues are currently being worked on.\n  - Blocked: these issues are being worked on but are blocked for some reason and need attention.\n  - Done: these issues have been completed and can be closed.\n\nIf you have questions, feel free to ask in the [Stellar Developer Discord](https://discord.gg/stellardev).\n\n## Quick Start\n[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)][codespaces]\n[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)][gitpod]\n\n### Prerequisites\n\nTo begin development on the documentation, you will first need to install the following:\n\n- Node.js (v22, or higher): see https://nodejs.org/en/download/package-manager for details for your system\n- npm: e.g. `sudo apt install npm` on Ubuntu\n- yarn: `npm install yarn`\n\n### Development\n\nOnce all the prerequisites have been installed, you can run the following commands:\n\n```bash\ngit clone https://github.com/stellar/stellar-docs\ncd stellar-docs\nyarn install\nnpx docusaurus start\n```\n\nThis will begin the development server, and open a browser window/tab pointing\nto `http://localhost:3000/docs/`. This development server will auto-reload when\nit detects changes to the repository.\n\nAfter you've made your changes, use the following commands to ensure the consistent\nMDX file formatting and style across the repository:\n\n```bash\nnpm run check:mdx # this will search for problems in the MDX files\nnpm run format:mdx # this will fix any problems that were found\n```\n\n## Repository Structure\n\n- `/docs/` Contains all the documentation content. If you're contributing to the\n  actual documentation, rather than site functionality, this is likely where you\n  will want to be.\n  - `/docs/\u003csubdirectory\u003e/` Each subdirectory inside the `docs` directory\n    contains content documents relating to a common idea (asset issuance, or\n    running a validator node, for example). There can also be subdirectories\n    nested even further, which will follow the same rules. The location of a\n    document within this directory structure will have a direct impact on the\n    URL given to the document on the site (unless there is metadata or front\n    matter that overrides these defaults.)\n  - `/docs/\u003csubdirectory\u003e/_category_.json` This file contains information that\n    determines the directory's location and position within the site's sidebar.\n  - `/docs/\u003csubdirectory\u003e/\u003cfilename\u003e.mdx` The actual documents live in these\n    files (written in Markdown), and also contains \"front matter\" which can\n    specify configuration parameter for the document's display, URL, etc. **All\n    filenames must use dashes for spaces instead of spaces or underscores**\n- `/src/` Contains non-documentation files like custom React components and\n  styling.\n- `/static/` Contains static assets. Anything in this directory will be copied\n  to the root of the final `build` directory.\n- `/nginx/` Contains configuration used to deploy and host the docs site. Unless\n  you're part of Stellar's IT Ops team, you probably don't need to do anything\n  with this. *Exception*:\n  - `/nginx/includes/redirects.conf` Contains redirect rules to avoid broken\n    links. If you find a broken link somewhere out in the wilds of the internet,\n    and there's no way for it to be changed, a redirect could be a useful tool.\n    (Note our aim isn't to *completely* avoid 404 pages for a user. That would\n    be impossible and impractical. These redirects are evaluated on a\n    case-by-case basis, and it may be determined that a redirect isn't the right\n    approach in some instances.)\n\n## Using Markdown\n\n### Markdown Basics\n\nIf you're unfamiliar with Markdown, there are **loads** of good tutorials and\ncheat sheets out there. Check out some of these resources to get a handle on the\nbasics:\n\n- [CommonMark cheat sheet and tutorial][commonmark]\n- [Interactive markdown tutorial][tutorial]\n- [The markdown guide][guide]\n\n### Custom Markdown\n\nOur repository uses some custom React components that can be used inside the\n`MDX` documents. Use them as follows:\n\n**Make sure that there is an empty line within the wrapper.** For example,\n\n```text\n\u003cAlert\u003e\n\u003c!-- EMPTY LINE AFTER THE COMPONENT'S OPENING TAG IS REQUIRED --\u003e\n\nNote: the testnet is reset every three months, so when building on it, make sure you have a plan to recreate necessary accounts and other data. For more info, check out the [best practices for using the testnet](../../learn/fundamentals/networks.mdx).\n\n\u003c!-- EMPTY LINE BEFORE THE COMPONENT'S CLOSING TAG IS REQUIRED --\u003e\n\u003c/Alert\u003e\n```\n\n#### Alert\n\n![Testnet reset alert](./readme-imgs/alert.png)\n\n`\u003cAlert /\u003e` is used to convey hints, warnings, etc. For example,\n[Build a SEP-31 Anchor on Testnet][alert-example]\n\n```markdown\nimport { Alert } from \"@site/src/components/Alert\";\n\n\u003cAlert\u003e\n\nNote: the testnet is reset every three months, so when building on it, make sure you have a plan to recreate necessary accounts and other data. For more info, check out the [best practices for using the testnet](../../fundamentals-and-concepts/testnet-and-pubnet).\n\n\u003c/Alert\u003e\n```\n\n#### Code Example\n\n![Create account code example](./readme-imgs/code-example.png)\n\n`\u003cCodeExample /\u003e` is a code snippet component. You can include snippets for more\nthan one language. See an example including a snippet for `JavaScript` and\n`Python` below. It is using [Prism React Renderer][prism] for syntax\nhighlighting.\n\n````markdown\nimport { CodeExample } from \"@site/src/components/CodeExample\";\n\n\u003cCodeExample\u003e\n\n```js\n// create a completely new and unique pair of keys\n// see more about KeyPair objects: https://stellar.github.io/js-stellar-sdk/Keypair.html\nconst pair = StellarSdk.Keypair.random();\n\npair.secret();\n// SAV76USXIJOBMEQXPANUOQM6F5LIOTLPDIDVRJBFFE2MDJXG24TAPUU7\npair.publicKey();\n// GCFXHS4GXL6BVUCXBWXGTITROWLVYXQKQLF4YH5O5JT3YZXCYPAFBJZB\n```\n\n```python\n# stellar-sdk \u003e= 2.0.0 required\n# create a completely new and unique pair of keys\n# see more about KeyPair objects: https://stellar-sdk.readthedocs.io/en/latest/api.html#keypair\nfrom stellar_sdk import Keypair\n\npair = Keypair.random()\nprint(f\"Secret: {pair.secret}\")\n# Secret: SCMDRX7A7OVRPAGXLUVRNIYTWBLCS54OV7UH2TF5URSG4B4JQMUADCYU\nprint(f\"Public Key: {pair.public_key}\")\n# Public Key: GAG7SXULMNWCW6LX42JKZOZRA2JJXQT23LYY32OXA6XECUQG7RZTQJHO\n```\n\n\u003c/CodeExample\u003e\n````\n\nLanguages that are currently being used in Documentation and API Reference are\nbelow:\n\n```js\n// https://github.com/stellar/stellar-docs/blob/main/src/components/CodeExample.js\n\nconst CODE_LANGS = {\n  bash: 'bash',\n  cpp: 'C++',\n  curl: 'cURL',\n  go: 'Go',\n  html: 'html',\n  java: 'Java',\n  javascript: 'JavaScript',\n  js: 'JavaScript',\n  json: 'JSON',\n  json5: 'JSON5',\n  python: 'Python',\n  scss: 'SCSS',\n  toml: 'TOML',\n  ts: 'TypeScript',\n  tsx: 'TSX',\n  typescript: 'TypeScript',\n  yaml: 'YAML',\n};\n```\n\n**Remember that this is a community; we build together! 🫱🏻‍🫲🏽 Our code of conduct is [here](https://www.stellar.org/community/code-of-conduct) and our Privacy Policy is [here](https://www.stellar.org/privacy-policy).**\n\n[docs]: https://developers.stellar.org/docs\n[api]: https://developers.stellar.org/api\n[stellar]: https://stellar.org\n[contrib]: https://github.com/stellar/.github/blob/master/CONTRIBUTING.md\n[coc]: https://github.com/stellar/.github/blob/master/CODE_OF_CONDUCT.md\n[docusaurus]: https://docusaurus.io\n[mdx]: https://mdxjs.com\n[commonmark]: https://commonmark.org/help/\n[tutorial]: https://www.markdowntutorial.com/\n[guide]: https://www.markdownguide.org/\n[alert-example]: https://developers.stellar.org/docs/anchoring-assets/enabling-cross-border-payments/setting-up-test-server\n[prism]: https://github.com/FormidableLabs/prism-react-renderer\n[codespaces]: https://github.com/codespaces/new?hide_repo_select=true\u0026ref=main\u0026repo=521307729\u0026machine=basicLinux32gb\u0026devcontainer_path=.devcontainer%2Fdevcontainer.json\u0026location=EastUs\n[gitpod]: https://gitpod.io/#https://github.com/stellar/stellar-docs\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstellar%2Fstellar-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstellar%2Fstellar-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstellar%2Fstellar-docs/lists"}