https://github.com/lukeclancy/otterly_site

Site for otterly js documentation. Takes markdown and file names from my otterly npm package's docs folder and converts them into rich html documentation. Can be repurposed with some work for other projects.
https://github.com/lukeclancy/otterly_site

Last synced: 13 days ago
JSON representation

Site for otterly js documentation. Takes markdown and file names from my otterly npm package's docs folder and converts them into rich html documentation. Can be repurposed with some work for other projects.

• Host: GitHub
• URL: https://github.com/lukeclancy/otterly_site
• Owner: LukeClancy
• Created: 2024-06-04T18:44:57.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-12-10T22:50:09.000Z (about 1 month ago)
• Last Synced: 2024-12-10T23:27:53.134Z (about 1 month ago)
• Language: Elixir
• Homepage:
• Size: 1.55 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Otterly Site

Site for [otterly js](https://github.com/LukeClancy/otterly/tree/main) documentation. Takes markdown and file names from my [otterly npm package's docs folder](https://github.com/LukeClancy/otterly/tree/main/docs) and converts them into rich html documentation. Can be repurposed with some work for other projects.

My goal here is to work with elixir/phoenix, look into technologies for quick iteration, test out otterly js, and create a good docs site for future projects. I want to work in surrealdb at some point too, but there will be some integration work there at some point as it doesn't play nice yet with phoenix.

Once again, this website is:

- a testing ground for phoenix technologies

- a testing ground for quick and effective website development

- a docs site, that should be reusable with minimal effort

Tech:

- surrealdb: Not yet implemented

- temple: Implemented, but I believe hex is a better option as hex seems quite usable, and temple is not compatible with various phoenix systems.

- bun: Quite good, super fast, still a few issues with it due to bugs. Main issue is CSS doesn't work with it yet. Thats not an issue with tailwind, but something to keep in mind. You do need custom code / settings (which I am coming to accept with bundlers) look at bundling.js. Its fine, but Im not sure its really worth it.

- elixir/phoenix: Settings are clear, documentation / syntax pops up real time, errors are obvious and mostly caught compile time. Code is clean and organized. It will take a bit to get used to, but shouldn't be too long.

- Tailwind: good for quick iteration, Im not very good at css so am a bit slow still.

### refresh the UA parsers

mix ua_inspector.download