문건은 현대화와 개선이 필요하다
4664 단어 handlebars-site
묘사
오랫동안 당신의 서류가 엉망이었어요.웹 사이트나github에 설명되지 않은 코드가 더 이상 없으면 기본 예시를 그대로 사용할 수 없습니다.
너의 예:
<div class="entry">
<h1>{{title}}</h1>
<div class="body">
{{body}}
</div>
</div>
var context = {title: "My New Post", body: "This is my first post!"};
var html = template(context);
더 많은 참여가 없었다면 진정으로 작용하지 않았을 것이다.이것은 엉터리 문서이기 때문에 우리 다른 사람들은 코드를 어떻게 사용하는지 많은 제3자 출처에 가서 알아야 한다.사전 컴파일링은 성능 면에서 일종의 방식으로 치켜세워졌지만, 문서는 더욱 엉망이었다.
<script id="entry-template" type="text/x-handlebars-template">
<div class="entry">
<h1>{{title}}</h1>
<div class="body">
{{body}}
</div>
</div>
</script>
var source = $("#entry-template").html();
var template = Handlebars.compile(source);
...더 많이 알고 싶어요?사전 컴파일링에 대해서는 다음을 제공합니다.Handlebars.templates.person(context, options);
우리는 모두 이것이 허튼소리라는 것을 알고 있지만, 어떻게 실제적으로 모범을 보여 주는지 설명하지 않았다.물론 수염을 누구나 다 안다는 핑계로 그들의 문서를 인용할 수 있지만, 이것은 지금까지 JS 라이브러리에서 가장 나쁜 문서라고 할 수 있다.
이 문서는 너무 엉망이어서, 나는 어떻게 다른 3개 사이트에서 부분적인 과장을 받아서 그 역할을 제대로 발휘할 수 있는지 되돌아볼 수밖에 없었다.하버드 비즈니스스쿨(HBS)의 대부분 강좌는 유행이 지났고 강의 내용이 당신 자신의 것보다 훨씬 많지만 상대적으로 잘하지 못한다.
나는'유성'에서'스페이스 바'를 사용했기 때문에 정말 손잡이를 사용하고 싶다. 그러나'유성'자체는 악몽이다. 비록 템플릿 제작이 매우 원활하지만.
차 손잡이는 분명히 잠재력이 있지만, 이러한 게으른 방식으로 사전 번역과 기본적인 부분 & 템플릿을 해석하기 때문에, 나는 그것을 통과하도록 계속 강요하는 것은 매우 매력적이지 않다.
토론 #1
나는 막 핸들을 사용하기 시작했지만 다른 사람과 협력하여 문서를 개선하는 것을 매우 기쁘게 생각한다.토론 #2
나는 실제로 페이지 밑에 있는 링크에서 로그인했다.나는 서류에 동의한다. 만약 네가 이미 손잡이를 장악했다고 가정한다면.나는 제공된 예에서 더 많은 상하문을 제공하고 싶다.만약 문서에 상하문이 없어서 낙담하는 사람이 있다면 Treehouse의 이 강좌는 매우 유용하다http://blog.teamtreehouse.com/handlebars-js-part-2-partials-and-helpers.이 글의 단추에는 다운로드 링크가 있는데, 위에 작업 예시가 있다.토론 #셋
손잡이.registerHelper의 적나라한 비극.심지어 함수의 매개 변수를 제시하지 않았다.어떻게 된 거야?토론 #4
https://devdocs.io/handlebars나는 이것이 매우 도움이 된다는 것을 발견했다.도움이 됐으면 좋겠어요!
원서https://github.com/wycats/handlebars-site/issues/192#issuecomment-482060778
토론 #5
나https://handlebars-lang.github.io/docs/.구형 사이트에서 컨텐츠 복제를 요청하여 도움을 받을 수 있습니다.또는 새로운 내용을 만들고 개선함으로써허락 없이 블로그나 다른 문서 사이트에서 원본 내용을 복사하지 마십시오.
토론 #6
HB에서 이사한 지 오래되었지만 시간이 있으면 볼게요.아마도 나는 적어도 이 문서들을 위해 공헌을 할 수 있을 것이다.우선, JSDocs 주석이 기능을 설명하는 데 도움이 될 수 있는 기회를 찾아 IDE에서 더욱 유용하게 사용할 수 있도록 코드를 검사하는 것을 권장할 수 있습니까?예를 들어 TypeDoc를 시작으로 할까요?
차이가 많지 않다
/**
* ```js
* @blockexpression
* A block expression uses double-curly braces to indicate
* interpolated code blocks within your HTML
* ```
*/
{{ blockexpression }}
편집 - 명확하게 말하자면, 나는 기존 코드에서 JSDocs와 호환되는 주석을 검사하고, 필요에 따라 주석을 추가하기 위해 PRs를 놓는 것을 권장한다. 우리는 TypeDoc를 사용하여 그것들을 끌어내서 새로운 docs 사이트를 더욱 유용하고 정확하게 할 수 있다.그러나 이것은 @wycats의 지원이 필요합니다. 그는 업데이트하기 전의 '문서' 에 대해 아무런 흥미가 없는 것 같습니다.
- 편집 종료
타자 스크립트에 대한 내용도 없다.@wycats가 이 문제를 해결하려고 하는지, 아니면 이lib가 너무 낡아서 실제 사용하는 사람과 관련이 없는지 확실하지 않습니다.
토론 #7
새 사이트 오픈.토론 #8
@nknapp다시 한 번 말씀드리지만 저는 HB를 오랫동안 사용하지 않았습니다. 이 문제를 일으킨 사이트 구역을 봤는데 어떻게 시작하는지 더 잘 알 수 있을 것입니다.
즉, 거의 모든 다른docs 사이트와 마찬가지로, 당신은 '입문' 링크를 고려할 수 있다.너의'용법'부분(2016년에 이 글을 발표했을 때 나는 분명히 격노했다)은 내가 입문에서 기대했던 내용을 거의 포함하고 있다.
내 2센트만.
이렇게 해줘서 고마워요. HB를 받아들여야 할 사람들한테 중요한 거니까요.
토론 #9
더 이상 참여하지 않으셔도 이 답안을 작성하도록 노력해 주셔서 감사합니다.나는 우리가 이야기한 것이 같은 일이라는 것을 확신하고 싶다.'설치' 페이지의 '사용' 부분을 더욱 눈에 띄는 위치에 놓고 메인 페이지와 직접 연결해야 한다는 뜻입니까?
토론 #10
@nknapp 네, 교과서 내용에 약간의 내용을 추가할 수 있습니다.이 부분은 내가 보고 싶은'입문'이지만, 나도 입문에 대한 설명을 더 많이 보고 싶다.
한 글자 한 글자의 업무 예시와 같다.이것은 보통 다른 라이브러리와 프레임워크 (예: React, Bootstrap) 에서 볼 수 있는 상황입니다.
토론 #11
현재 구조 배후의 사상은 CDN이 가장 간단한 시작 방식이지만 그 어떠한 상황에서도 실제 프로젝트에서 사용해서는 안 된다는 것이다.이것은 node를 설치하는 것보다 훨씬 간단하다. 내가 보기에 node는 실제 용례이다.실제로 나는 더 이상 브라우저에서 사용 손잡이를 홍보하고 싶지 않다. 지금은 더 좋은 프레임워크 (Vue, React, Ember, Angular 등) 가 있다.
하지만 나는 그것을 언급할 것이다. 왜냐하면 이것은 가능하기 때문에, 나는 그 부분을 가능한 한 먼 뒤로 옮겼다.
그리고 Handlebar의 특이한 점은 다양한 언어(Java, Rust)의 실현이 있다는 것이다. 이것이 바로 내가 가능한 한 JavaScript에 관심을 두지 않으려는 부분이다.
이런 생각은 한 번에 너무 많은 것 같다.생각해볼게요.당신의 피드백에 감사 드립니다.
Reference
이 문제에 관하여(문건은 현대화와 개선이 필요하다), 우리는 이곳에서 더 많은 자료를 발견하고 링크를 클릭하여 보았다 https://github.com/wycats/handlebars-site/issues/156텍스트를 자유롭게 공유하거나 복사할 수 있습니다.하지만 이 문서의 URL은 참조 URL로 남겨 두십시오.
우수한 개발자 콘텐츠 발견에 전념 (Collection and Share based on the CC Protocol.)