mpociot / whiteboard Goto Github PK
View Code? Open in Web Editor NEWSimply write beautiful API documentation.
License: Other
Simply write beautiful API documentation.
License: Other
I'm trying to use:
\```http
GET http://localhost
\```
but it's not working.
Does whiteboard support rouge?
Hi,
Can I include ejs files from ejs files ? It was possible in Slate with the erb partial syntax, I didn't find a way to do it here with ejs.
This is currently my project achitecture :
Currently, I can't include ejs files from the index. And index.md can't be an ejs file.
Thanks,
Love this project, nice work.
I'm using GitHub pages on my repo so that my documentation is easily hosted/updated. Every time I push to master and it builds, it sends me the warning below via email. Everything still works, but that warning is super annoying.
The problem is this line of my _config.yml
file.
Any ideas?
The page build completed successfully, but returned the following warning for the
master
branch:You are attempting to use a Jekyll theme, "whiteboard", which is not supported by GitHub Pages. Please visit https://pages.github.com/themes/ for a list of supported themes. If you are using the "theme" configuration variable for something other than a Jekyll theme, we recommend you rename this variable throughout your site. For more information, see https://help.github.com/articles/adding-a-jekyll-theme-to-your-github-pages-site/.
For information on troubleshooting Jekyll see:
https://help.github.com/articles/troubleshooting-jekyll-builds
If you have any questions you can contact us by replying to this email.
as the title states, I separated each section out of the demo and put them into the includes folder. I did not change the markdown but the data.content that's passed to the after_post_render does not include the included files even though according to Hexo documentation it should be.
Are there plans to release an npm module for this? I'd like to create a workflow where I can install whiteboard as a local dependency and use scripting to have it generate a Github page. I can use the repo url as my dependency, but I'd rather have an official versioned module to grab from npm.
The Slate API mentions the ability to give languages friendly names. Ergo, if you want shell Markdown formatting but want to call it "curl."
When I tried this in Whiteboard it didn't work. The most obvious problem was that the languages in the UI navigation looked like [object Object]
instead of Node
, etc. I had to do the following hacks:
In script.js
I added this function:
function languageDetails(lang) {
if (typeof(lang) === 'string') {
return { lang, name: lang }
}
// If it's an object, then it's [language]: [name]
let keys = Object.keys(lang);
lang = keys[0];
return { lang: lang, name: lang[lang] };
}
And then in setupLanguages
I changed this line in my fork to make use of it:
languages = l.map(row => languageDetails(row).lang);
Then in index.ejs
I changed the language tabs HTML to this ugly mess:
<% if (typeof(language_tabs[lang]) === 'string') { %>
<a href="#" data-language-name="<%= language_tabs[lang] %>"><%= language_tabs[lang] %></a>
<% } else { %>
<a href="#" data-language-name="<%= Object.keys(language_tabs[lang])[0] %>"><%= language_tabs[lang][Object.keys(language_tabs[lang])[0]] %></a>
<% } %>
Thanks!
i got blank index.html after do hexo generate / npm run generate
what should i check ?
Just cloned the repo and also noticed on the Demo that none of the icons in the are displaying, its just a box.
Errors from the demo:
http://www.marcelpociot.com/whiteboard/css/font-icon-path.ttf?v=#font-icon-version Failed to load resource: the server responded with a status of 404 (Not Found)
http://www.marcelpociot.com/whiteboard/css/font-icon-path.woff?v=#font-icon-version Failed to load resource: the server responded with a status of 404 (Not Found)
This was tested on latest versions of Chrome and Firefox.
Hello,
How can I use this with PM2?
Just wanna say thank you for doing this! i've found about slate a month ago but i don't wanna install ruby in order to use it, so your solution works for me and my team :)
Hello,
I'm trying to define a variable (eg : a variable containing the api url to be used in examples). I tried different ways (changing files extensions) but I don't think it's the correct way (whatever, it just don't work !).
I managed to do this on a Slate-based API documentation, but how should I do this on Whiteboard?
Given this problem, I did some tests and it appears to me that it's not possible to use the "page" attributes (like page.title
) or use page.api_url
which I defined in my index file. Am I wrong ?
Thanks in advance for your help, I really appreciate your work on this projects as it's simple to setup :)
Best regards.
Couldn't find in the docs an explanation about the API build workflow - what input does whiteboard need in order to generate API docs: swagger, js doc, annotated API, etc?
I am getting this error when issuing the npm install command.
Error: Cannot find module 'C:\postinstall'
I'm running on Windows 10, not sure if that's why it's failing or if there are other dependencies that are needed?
Thanks.
Active Code Tab and Code Styling doesn't work on generated html files. Look image.
Npm install gave error while installing. On windows.
npm WARN install Couldn't install optional dependency: Unsupported
npm WARN install Couldn't install optional dependency: Unsupported
npm WARN prefer global [email protected] should be installed with -g
Hello @mpociot and well done for your awesome work.
I am actually having trouble with the json display.
Indeed, my "nested" json isn't displaying properly with pink color for attributes.
Any idea on how to fix this ?
Is it possible to customize the size of middle pane? For example to higher portion rate of screen?
Thank you.
The below JSON represents a sample request:
{
"groupName":"Test API Doc",
"groupDescription":"This group is to test API Docs",
"isPublic":true,
"rules":
[
238,
242
]
}
A declarative, efficient, and flexible JavaScript library for building user interfaces.
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. ๐๐๐
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google โค๏ธ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.