FreeBSD online man page editor

An online man page editor for the FreeBSD man page. Only front-end with HTML, CSS, and JS in this editor. Using Jroff to render mdoc.

Online website

Installation

node.js >= v16.13.1 npm >= v8.18.0

$ npm install

Related commands:

$ npm run build # Generate production code
$ npm run eslint # Check JavaScript code formatting with ESLint
$ npm run eslint-fix # Automatically format JavaScript code with ESLint
$ npm run prettier # Check HTML and CSS code formatting with Prettier
$ npm run prettier-fix # Automatically format HTML and CSS code with Prettier

Package

1. Ace.js@1.11.2: using the Cloudflare CDN to include.
2. Jsdiff@5.1.0: using the Cloudflare CDN to include.

Open in the local server

There are three ways to open the website on the local server that can help you develop. When you change the code, you can see the change on the local server immediately.

1. VSC extension

You can easily open a local server through the liver-server extension.

2. Node.js

Use the npm package, "http-server" to open a local server.

$ npm install --global http-server
$ http-server /root [options]

Advanced usage of http-server.

3. FreeBSD

We will use apache24 to open the local server.

$ pkg install apache24 # Install apache
$ vim /usr/local/etc/apache24/httpd.conf

Change the "ServerName" column to your ip and 80 port. The "DocumentRoot" and "Directory" tag also need to be set to the root directory.

ServerName www.example.com:80

DocumentRoot "/path-to-project/"
<Directory "/path-to-project/">
  Options Indexes FollowSymLinks
  AllowOverride None
  Require all granted
</Directory>

Please refer Apache document

$ service apache24 configtest # Check for errors in the httpd.conf file
$ service apache24 start # Start the Apache service

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

License

MIT