Requires nodejs version 18 or higher
- After cloning, run
npm installto install dependencies - Generate documentation
- For dummy content run
npm run dummy_docsOR - For actual content see "Generating versioned documentation" below
- Start the development server:
npm run dev
# or
yarn dev
# or
pnpm devOpen http://localhost:3000 with your browser to see the result.
You can start editing the page by modifying app/page.tsx. The page auto-updates as you edit the file.
Clone documentation repos in parallel folders next to this one
- clone https://github.com/oskariorg/oskari-documentation -> (Should be found in
../oskari-documentation) - clone https://github.com/oskariorg/oskari-frontend -> (Should be found in
../oskari-frontend) - clone https://github.com/oskariorg/oskari-server -> (Should be found in
../oskari-server) - Run
npm run docs [version] [bln_latest]where:
[version]is like2.13.0(defaults to unreleased)[bln_latest]is liketrue(defaults to false)
This:
- shovels in everything under
oskari-documentationto_content/docs/[version]/ - copies
ReleaseNotes.mdandapi/CHANGELOG.mdto_content/docs/[version]/[ordinal] Changelog/
Q. Somethings doesn't seem to work properly. What can I do?
A. Try removing the .next folder from the repository root that has been generated by the last time the application was built. Run build again and check if it helped (most unusual problems are fixed by this).
This is a Next.js project bootstrapped with create-next-app.
This project uses next/font to automatically optimize and load Inter, a custom Google Font.
To learn more about Next.js, take a look at the following resources:
- Next.js Documentation - learn about Next.js features and API.
- Learn Next.js - an interactive Next.js tutorial.
You can check out the Next.js GitHub repository - your feedback and contributions are welcome!