[opensourcedex]

oscean is a free, open source documentation & knowledge base project written in HTML and released under MIT. It has 561 GitHub stars, 81 forks and 8 open issues, and was last pushed 11 hours ago. On this registry it ranks #84 of 91 tracked projects in Documentation & Knowledge Base, with 5 head-to-head comparisons available.

Oscean

This is the repository for the Oscean wiki, see the on-site documentation for more up-to-date details. Oscean is a static site written in Uxntal, a stack-machine assembly language designed for a portable virtual machine. The database tables are stored as plain-text files designed to fit in Uxn's 64kb of memory. The main branch is the live version.

Build

The oscean.rom file can be assembled with drifblim.

uxnasm src/oscean.tal bin/oscean.rom # build wiki engine

The pre-processor step generates temporary files for oscean to populate the wiki with.

  • entry-log, contains all the diary logs for that entry.
  • entry-map, contains all the incoming links for that entry.

The rom does not have a graphical interface, but can be used with the uxncli emulator:

Run

uxncli bin/oscean.rom

Extras

  • Pull Requests are welcome.
  • See the License file for license rights and limitations(MIT), the media assets are BY-NC-SA 4.0.

Frequently asked questions

Is oscean free to use?

oscean is open source under the MIT licence. There is no licence fee and no seat count — you can self-host it or, where the project offers one, pay a vendor for a managed version instead.

What does oscean do?

Static wiki engine written in Uxntal

What is oscean written in?

oscean is primarily written in HTML. Its source is publicly available at https://github.com/XXIIVV/oscean, and it has 561 GitHub stars.