/lnr-docs

docs for linagee name registrar

Primary LanguageJavaScriptMIT LicenseMIT

Linagee documentation website

The documentation website is hosted at https://docs.linagee.app

It was built using Docusaurus 2, a modern static website generator that allows you to write Markdown files and generate a beautiful static website.

Steps to writing/updating documentation

  1. Clone the repo

  2. Install dependencies

    npm install

  3. Make your changes to the markdown files in the /docs folder

  4. Run the development server

    npm start

  5. Open the documentation in your browser at http://localhost:3000/ and make sure everything looks good

  6. When you are done, build the static site

    npm run build

    Then publish it in your favorite location. I recommend using Vercel to host the static site. It's free and easy to use.

  7. Commit and push your changes to the main branch or create a pull request to merge your changes into this repo.