rhiokim / flybook Goto Github PK
View Code? Open in Web Editor NEW:airplane: FlyBook is a simple utility to generate static website such as gh-pages, manual of you projects
Home Page: https://rhiokim.github.io/flybook
:airplane: FlyBook is a simple utility to generate static website such as gh-pages, manual of you projects
Home Page: https://rhiokim.github.io/flybook
As I can see, until now, custom document doesn't support yet. It's very powerful feature for me who would like to customize layout of the page. It can be possible that there are many layout template made by users. Concept is inspired from next.js. For example of no header / sidebar,
import {Head, Style, Body, Sidebar, Page, Footer} from 'flybook/layout'
export default () => (
<html>
<Head>
<Title title="my boo">
<Style>
<Link src="xxx.css>
</Style>
</Head>
<Body>
<!-- NO SIDEBAR, NO HEADER -->
<Page>
<NextScript />
</Body>
</html>
)
assets file such as image, audio and video should be copied to output directory
When I run npm task, face a problem.
> [email protected] docs C:\workspace\rxjs-book
> flybook docs --outdir=out
> Part1 - 1 01.intro
C:\workspace\rxjs-book\out\part1\1-01.intro.html
> Part1 - 1 02.input
C:\workspace\rxjs-book\out\part1\1-02.input.html
> Part1 - 1 03.propagation
C:\workspace\rxjs-book\out\part1\1-03.propagation.html
fs.js:641
return binding.open(pathModule._makeLong(path), stringToFlags(flags), mode);
^
Error: ENOENT: no such file or directory, open 'C:\workspace\rxjs-book\docs\resources\A-B-use.png'
at Error (native)
at Object.fs.openSync (fs.js:641:18)
at copyFileSync (C:\workspace\rxjs-book\node_modules\fs-extra\lib\copy-sync\copy-file-sync.js:21:18)
at copySync (C:\workspace\rxjs-book\node_modules\fs-extra\lib\copy-sync\copy-sync.js:43:5)
at C:\workspace\rxjs-book\node_modules\flybook\dist\libs\main.js:175:27
at Array.forEach (native)
at exports.default (C:\workspace\rxjs-book\node_modules\flybook\dist\libs\main.js:174:9)
at gen (C:\workspace\rxjs-book\node_modules\flybook\dist\bin\cli.js:81:22)
at Object.<anonymous> (C:\workspace\rxjs-book\node_modules\flybook\dist\bin\cli.js:115:5)
at Module._compile (module.js:570:32)
> git status
deleted: docs/resources/A-B-use.png
In my experience, it's often useful to use flybook as a wiki doc. So, It might be reasonable for the additional syntax or plugin to support wiki syntax and more
제의 웹서버 설정이 디렉토리를 보여주는 식으로 되어있어서 알게되었습니다.
<a href="/part1\1-01.intro">1 01.intro</a>
/part1\1-01.intro/index.html로 명시 해주면 좋을것 같아요.
마찬가지로 상대경로로 되면 좋겠습니다. #6
Git CMD
flybook docs
명령어를 실행할 경우 Object.entries is not a function
TypeError 발생flybook/components/layout.js
, 26번째 줄yarn init
yarn add flybook -D
./package.json
파일에 "scripts"
커맨드 추가: "docs": "flybook docs --outdir=out"
yarn docs
C:\test>
C:\test>npm --version
3.10.10
C:\test>yarn --version
0.24.5
C:\test>type package.json
{
"name": "test",
"version": "1.0.0",
"main": "index.js",
"license": "MIT",
"scripts": {
"docs": "flybook docs --outdir=out"
},
"devDependencies": {
"flybook": "^1.0.7"
}
}
C:\test>yarn docs
yarn docs v0.24.5
$ flybook docs --outdir=out
C:\test\node_modules\flybook\dist\components\layout.js:58
Object.entries(toc[key]).map(function (item, i) {
^
TypeError: Object.entries is not a function
at C:\test\node_modules\flybook\dist\components\layout.js:58:20
at Array.map (native)
at module.exports (C:\test\node_modules\flybook\dist\components\layout.js:54:26)
at C:\test\node_modules\react-dom\lib\ReactCompositeComponent.js:306:16
at measureLifeCyclePerf (C:\test\node_modules\react-dom\lib\ReactCompositeComponent.js:75:12)
at ReactCompositeComponentWrapper._constructComponentWithoutOwner (C:\test\node_modules\react-dom\lib\ReactCompositeComponent.js:305:14)
at ReactCompositeComponentWrapper._constructComponent (C:\test\node_modules\react-dom\lib\ReactCompositeComponent.js:280:21)
at ReactCompositeComponentWrapper.mountComponent (C:\test\node_modules\react-dom\lib\ReactCompositeComponent.js:188:21)
at Object.mountComponent (C:\test\node_modules\react-dom\lib\ReactReconciler.js:46:35)
at ReactCompositeComponentWrapper.performInitialMount (C:\test\node_modules\react-dom\lib\ReactCompositeComponent.js:371:34)
error Command failed with exit code 1.
C:\test>
위 이슈 확인 부탁드립니다.
감사합니다~
Support MDX
상대 경로로 바꿔줄수는 없나요?
<link rel="stylesheet" href="/static/css/normalize.css" />
<link rel="stylesheet" href="/static/css/flexboxgrid.min.css" />
<link rel="stylesheet" href="/static/css/github-flavored-markdown.css" />
<link rel="stylesheet" href="/static/css/main.css" />
<link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/solarized-dark.min.css" />
you can create a table of contents using headline title like this
## title
### title1
### title2
A
How about supporting a table of contents?
Detailed Description
- docs
\_ sample.md
\_ toc.yml
결과물의 스타일링에 개선이 가능한 요소가 보입니다.
리스트(<li>
) 엘리먼트가 계층을 가질 경우, 하위 엘리먼트가 있는 <li>
에 margin-top
, margin-bottom
이 각각 16px
씩 잡혀 있어 보기에 위 아래 간격이 조금 부자연스럽게 떨어져 있습니다.
이 여백을 조절하면 더 보기 좋은 리스트 마크업을 만들 수 있을 것 같습니다.
다음의 마크업 코드로 테스트 가능합니다.
* line 1
* line 2
* line 3 // where margin problem happens
* sub-line 1
* sub-line 2
한 번 검토 부탁드립니다.
오랜만에 이슈를 등록합니다. 오랫동안 참여를 하지 못했지만.. 까먹지 않기 위해 등록해 둡니다.
현재 flybook으로 작성한 웹페이지의 하단에 삽입되는 "All rights reserved." 문구의 앞에
연도가 표시되는데요, 이를 문서 출력 후에 수동으로 바꾸는 방법 외에
적절히 아름답게 옵션으로 제어할 수 있는 방법이 현재로썬 없는 것 같습니다.
이를 제어할 수 있는 기능이 들어가면 좋을 것 같습니다.
###에러 내용
> [email protected] docs C:\workspace\rxjs-book
> flybook docs --outdir=out
? There is no `toc.yml` which is table of contents file to generate static book
Please create table of content [Y/n]
(node:7508) UnhandledPromiseRejectionWarning: Unhandled promise rejection (rejection id: 1): Error: ENOENT:
no such file or directory, open 'C:\workspace\rxjs-book\docs\C:\workspace\rxjs-book\docs\part1\1-01.intro.md
$ fly-book docs —theme=dark
Detailed Description
- docs
\_ Korean.md
\_ English.md
\_ toc.yml
LNB 영역의 문서 링크를 재차 클릭하면, 링크 중간에 .%5C
특수기호(.\
을 의미)가 붙습니다.
flybook docs --outdir=out --prod --silent
)gh-pages -d out
)위 문제 확인 부탁드립니다.
감사합니다.
ISO Specification : iso-639-1
- docs
\_ ko
\_ readme.md
\_ basic
\_ a.md
\_ b.md
\_ en
\_ zh
\_ ...
[HOST]/ko/index.html
<- docs/ko/readme.md
[HOST]/ko/basic/a.html
<- docs/ko/basic/a.md
[HOST]/ko/basic/b.html
<- docs/ko/basic/b.md
[HOST]/en/basic/a.html
<- docs/en/basic/a.md
I faced the issue that redirecting github page doesn't work when it uses of git+https url in package.json
"repository": {
"type": "git",
"url": "git+https://github.com/seouljs/seouljs.github.io.git"
},
flybook generates this elements below:
<a href="git+https://github.com/seouljs/seouljs.github.io.git">Github</a>
gh-pages
브랜치에 정적페이지 생성 후 결과물을 확인해보면 GNB 영역의 링크들이 예상대로 만들어지지 않습니다.
https://djkeh.github.io/project
https://djkeh.github.io/
https://djkeh.github.io/project
https://djkeh.github.io/
https://github.com/djkeh/project
./package.json
파일에 아래 참고와 같이 "scripts" 커맨드 추가package.json
{
"name": "project",
"version": "1.0.0",
"main": "index.js",
"repository": "https://github.com/djkeh/project.git",
"author": "Uno Kim <[email protected]>",
"license": "MIT",
"scripts": {
"docs": "flybook docs --outdir=out --silent --font=Noto+Sans --codeStyle=androidstudio --theme=light",
"pages": "gh-pages -d out"
},
"devDependencies": {
"flybook": "^1.4.1",
"gh-pages": "^1.0.0"
}
}
위 이슈 확인 부탁드립니다.
감사합니다~
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.