{
  "id": "dd96ed7ba002e5bd98621429",
  "source": "solid:signals",
  "type": "github-document",
  "title": "README",
  "content": "\u003cp\u003e\n  \u003cimg src=\"https://assets.solidjs.com/banner?project=Solid%20Documentation\u0026type=core\" alt=\"Solid Documentation\" /\u003e\n\u003c/p\u003e\n\nWelcome to Solid's documentation!\n\nThis is the repo for [﻿docs.solidjs.com](https://docs.solidjs.com/). This repo\ncontains all the source code that we use to build our docs.\n\n[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/solidjs/solid-docs-next)\n[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/github/solidjs/solid-docs-next/)\n[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/solidjs/solid-docs-next)\n\n## What is Solid?\n\nSolid is a JavaScript framework used for building high-performance\nuser-interfaces. Using a reactive approach and component-based architecture, we\nwant to empower developers in creating efficient and scalable web applications.\n\n## Thank you for being here!\n\nYou can help make our docs better for the community! Your feedback is welcomed.\nIn addition, any editing, translating, designing, and developing skills are\nwelcomed. We are grateful to welcome you into our community!\n\nIf you want to see how you can contribute, check out our\n[﻿How You Can Help](#how-you-can-help) section.\n\n## Chat with us\n\nYou can learn more about Solid, get support, and meet other devs and\ncontributors in our [﻿Discord community](https://discord.com/invite/solidjs).\n\n## Raise an issue\n\nHave you noticed something is missing, confusing, or is wrong in our\ndocumentation?\n\nCheck to see if it has\n[﻿already been mentioned ](https://github.com/solidjs/solid-docs-next/issues)\nand, if not,\n[﻿create an issue](https://github.com/solidjs/solid-docs-next/issues/new/choose)\nto bring it to our attention!\n\n## Share an idea\n\nDo you think something could be better? Have an idea you feel could make the\ndocs better?\n\nDiscussion threads are where you can offer feedback on things that might not be\nproblems that need addressing, but are ideas to be explored.\n\nJoin us in the\n[﻿Discussions section](https://github.com/solidjs/solid-docs-next/discussions/280)\nwhere we can brainstorm these ideas, ask questions, and share goals!\n\n## Suggest a fix or contribute\n\nHave you found a typo, broken link, or another item with an obvious quick fix?\n\nIf you can see what the problem is, and you know how to fix it, you can make a\nPR (pull request) with the change and contribute to the docs repo yourself.\n\nIf you're looking to make a larger contribution, please see our\n[﻿CONTRIBUTING.md](https://github.com/solidjs/solid-docs-next/blob/main/CONTRIBUTING.md)\nfirst!\n\n## Running the Site Locally\n\nAt the moment, we recommend running the site locally through either\n[﻿CodeSandbox](https://codesandbox.io/p/github/solidjs/solid-docs-next/),\n[﻿Gitpod](https://gitpod.io/#https://github.com/solidjs/solid-docs-next), or\n[﻿StackBlitz](https://stackblitz.com/github/solidjs/solid-docs-next). These are\nthe quickest and easiest way to browse and edit the project files and run the\nsite locally.\n\nThe app uses [pnpm](https://pnpm.io) as the package manager and it runs on Node.js `v18+`.\n\nInstall dependencies:\n\n```sh\npnpm i\n```\n\nAnd run the local dev server:\n\n```sh\npnpm dev\n```\n\nThis will start your the app at [localhost:3000](http://localhost:3000) or the next available port.\n\n### Collections and virtual modules\n\nThe builds an [Astro](https://docs.astro.build/en/guides/content-collections/) inspired collection navigation, it will bring all routes and generate a couple of files at `/.solid`.\nThese files are exposed to your app via [Vite virtual modules](https://vitejs.dev/guide/api-plugin#virtual-modules-convention). This task is perform via our `sync` script (`pnpm sync`), ran before every build.\n\nIf changes are made to the navigation (new entry, or repositioning entry), it is necessary to restart the server for changes to take effect.",
  "url": "https://github.com/solidjs/solid-docs/blob/HEAD/README.md",
  "metadata": {
    "path": "README.md",
    "repo": "solidjs/solid-docs",
    "repo_url": "https://github.com/solidjs/solid-docs.git",
    "size": 3955,
    "source_type": "github"
  },
  "hash": "43cb89f652f3d81d074964d0005521a91fc6ab5b59e3a64a545d87139c8bb336",
  "timestamp": "2026-02-23T11:43:00.185824255+01:00"
}