search

hexojs / hexo

A fast, simple & powerful blog framework, powered by Node.js.
https://hexo.io
MIT License
39.49k stars 4.86k forks source link

Changelog and API Docs #341

Closed sergiolepore closed 10 years ago

sergiolepore commented 11 years ago

It would be great if you create a changelog.md file and make a historical record of all releases :smile: Also, an API doc to describe every variable and function exposed by hexo module could be very helpful to plugin developers and core developers.

tommy351 commented 11 years ago

You can see the changelog here: https://github.com/tommy351/hexo/releases

BTW, what's the best way to build an API doc for a Node.js project? Or maybe write a Hexo plugin for this?

sergiolepore commented 11 years ago

Releases: So cool! :) are you using SemVer standard? http://semver.org/ API: tomorrow I'll be meeting a Auth0 developer. 'll ask him what uses to write documentation.

I'll keep you updated!

sergiolepore commented 10 years ago

Sorry for the delay! I've been with some personal issues. Whatever, this friend of mine (the Auth0 developer) told me that they wrote their API docs without any tools. If you agreed, I could study every public variable, test them on plugins or in a new hexo core functionality (like draft management that I wrote a time ago), and then write a doc proposal. I'm pretty sure that if Hexo have an API doc, it would be easier to write code for it :smile:

tommy351 commented 10 years ago

Ok, I'll write an API doc after refactory.

sergiolepore commented 10 years ago

Hey! Thank you so much! :heart_eyes:

tommy351 commented 10 years ago

Hexo API doc has been released! http://zespia.tw/hexo/api/classes/Hexo.html

floriancargoet commented 10 years ago

Awesome! Thank you very much.

sergiolepore commented 10 years ago

Nice! Thank you so much! El ene 14, 2014 6:05 a.m., "SkyArrow" notifications@github.com escribió:

Hexo API doc has been released! http://zespia.tw/hexo/api/classes/Hexo.html

— Reply to this email directly or view it on GitHubhttps://github.com/tommy351/hexo/issues/341#issuecomment-32248459 .