This repository contains the source code for the official documentation of QuickFIX/J, the premier open-source Java implementation of the FIX (Financial Information eXchange) Protocol.
The site is built using Docusaurus, a modern static website generator.
Access the live documentation site here: https://quickfix-j.github.io/quickfixj-pages
To contribute to the documentation or run the site locally, follow these steps:
- Node.js (>= 20.0)
- npm, yarn, or pnpm
Clone the repository and install the dependencies:
git clone https://github.com/quickfix-j/quickfixj-pages.git
cd quickfixj-pages
npm install
# or yarn installStart a local development server:
npm run start
# or yarn startThis command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
To generate static content into the build directory:
npm run build
# or yarn buildThe generated files can be served using any static hosting service.
docs/: Contains all the Markdown (.md/.mdx) files for the documentation. This is where you'll spend most of your time when contributing content.src/: Contains React components, pages, and custom CSS used by the Docusaurus theme.static/: Contains static assets like images, logos, and favicons.sidebars.ts: Configuration file for defining the structure and order of the documentation sidebar.docusaurus.config.ts: The main configuration file for the Docusaurus site.
Contributions to the documentation are welcome! If you find a typo, want to clarify a concept, or add a new tutorial:
- Fork the repository.
- Create a new branch for your changes.
- Make your edits in the
docs/folder. - Preview your changes locally.
- Submit a Pull Request.