Getting Started
This guide will have you up and running generating your own Neko website in just a few minutes.
What is Neko?
Neko is a website generator that turns your Markdown .md files into a beautiful and functional documentation website. No coding required. Just write in Markdown and Neko handles the rest.
Neko is perfect for:
- Project documentation
- Knowledge bases
- API docs
- Personal blogs or notes
- Team wikis
- Self-publishing content
Step 1: Installation
The first thing to complete is installing Neko.
Once you have Neko installed, you can verify using the following command to output the Neko version number:
neko --version
If the above is not working, then Neko is not installed.
Step 2: Start Neko
Still using the command line, navigate to any folder with Markdown files:
cd your-project-folder
If you do not have Markdown files in that directory, create a new file such as the following readme.md:
// Content of ../samples/_includes/basic-page.md would be displayed here.
// (File reading not fully integrated)Then run the command neko start:
neko start
That's it! Neko will automatically:
- Find your Markdown files
- Build your website
- Open it in your browser
- Watch for changes and reload the browser automatically
Next Steps: Add more content
Neko supports standard Markdown plus powerful extensions. Experiment with adding the following markdown to your page.
Basic Markdown
<!-- Include file not found: snippets/markdown-sample -->
Components and Settings
Now with a basic introduction to Markdown options, explore the following Neko features:
[[Components]] : Rich content blocks like [[table]]s [[callout]]s, [[tab]]s, and much more.
Project settings : Project level configuration for your website
Page settings : Page level configuration options
Hosting
To generate the static website files, run the following command:
neko build
By default, the files will be copied to a new .neko folder within your project, although this is configurable with the output setting.
The build should only take a few moments to complete. If you have your own web server, you can FTP or copy the files from the .neko directory to the web server.
You can also host your new website using [[GitHub Pages]], [[Cloudflare]], [[GitLab Pages]], [[Docker]], [[Netlify]], or absolutely any other web hosting service.