jekyll wikilinks 다운로드 -Jekyll jekyll wikilinks 소스 코드 다운로드

jekyll wikilinks

기타 카테고리

1.0.0

다운로드

Jekyll-Wikilinks

V0.0.13 기준 으로이 플러그인은 `jekyll-wikirefs` 로 이동했습니다

Jekyll-Wikilinks는 Jekyll에 대한 Wikilinking (Double Square Bracket Syntax-[this]) 지원 등을 추가합니다.

이 보석은 jekyll-graph 와 함께 작동합니다.

이 보석은 Jekyll-Bonsai 프로젝트의 일부입니다.

설치

jekyll-wikilinks 용 Jekyll 플러그인을 설치하려면 지침을 따르십시오.

구성

기본값은 다음과 같습니다.

 wikilinks :
  attributes :
    enabled : true
  css :
    exclude : []
    name :
      typed : ' typed '
      wiki : ' wiki-link '
      web : ' web-link '
      invalid_wiki : ' invalid-wiki-link '
      embed_container : ' embed-container '
      embed_title : ' embed-title '
      embed_content : ' embed-content '
      embed_link : ' embed-wiki-link '
      embed_image_container : ' embed-image-container '
      embed_image : ' embed-image '
  enabled : true
  exclude : []

attributes : ON/OFF 속성 및 블록 레벨 Wikilinks 토글. attributes 끄면 메타 데이터가 각 문서에 추가되지 않으며 블록 레벨 Wikilinks는 문서의 내용에서 제거되지 않습니다.

css_names : Customiztable CSS 클래스 이름.

css.exclude : wiki 또는 web CSS 클래스가 추가되지 않아야하는 CSS 클래스 목록을 정의합니다.

web-link CSS 클래스가 추가되지 않아야하는 다른 내부 링크가있을 때 유용합니다. 예를 들어, kramdown footnote 와 reversefootnote CSS 클래스를 각주 인 a 에 추가합니다. 사이트 내부 링크이므로 wiki-link 를 추가하지는 않지만 web-link 이러한 요소에 추가하는 것은 바람직하지 않을 수 있습니다. 이로 인해 플러그인의 CSS 처리에서 제외하고 해당 클래스를 개별적으로 스타일링 할 수있는 후보자가 좋은 후보자가됩니다.

enabled : 플러그인을 끄거나 끄기 위해 전환합니다.

exclude : Jekyll-Wikilinks 플러그인에서 처리하지 않도록 제외 된 문서 목록에 Jekyll 유형 (이름 별 pages , posts 또는 collections )이 추가 될 수 있습니다.

통사론

인라인 파일 레벨 Wikilinks

 [[ filename ]]

이 링크는 filename.md 라는 한 Jekyll 프로젝트의 어느 곳에서나 Markdown 문서와 일치합니다. 파일 이름은 고유하고 공백이 허용되며 케이스는 무시됩니다. 파일의 title 프론트 매스터 속성은 a TAG의 내부 텍스트로 렌더링됩니다.

결과 HTML :

 < a class =" wiki-link " href =" url " > lower-cased frontmatter title attribute </ a >

인라인 입력 파일 레벨 Wikilinks

link_type:: [[ filename ]]

유형에는 공백이 포함되어 있지 않아야합니다. (Kabob-Case가 권장되지만 Snake_case와 Camelcase도 작동합니다)

이 Wikilinks는 Unttyped Wikilinks와 같은 곳에서 렌더링되었습니다. 또한 주어진 링크 유형의 이름을 가진 CSS 클래스뿐만 아니라 typed CSS 클래스를 추가합니다.

결과 HTML :

 < a class =" wiki-link typed link_type " href =" url " > lower-cased frontmatter title attribute </ a >

블록 (유형) Wikilinks

문서의 attributes 이라고도하는 블록 위키 링크는 한 줄의 유일한 텍스트 인 wikilinks를 입력합니다.

 link_type::[[filename]]

Some more text.

목록도 지원되며 쉼표로 분리 또는 마크 다운 목록에 의해 정의 될 수 있습니다 (모든 항목에 대한 총알 유형 일치, 예를 들어 모든 항목을 사용하십시오 +'s, -'s 또는 *'s).

 link_type::[[file-1]], [[file-2]], [[file-3]]

link_type::
- [[file-1]]
- [[file-2]]
- [[file-3]]

link_type::
+ [[file-1]]
+ [[file-2]]
+ [[file-3]]

link_type::
* [[file-1]]
* [[file-2]]
* [[file-3]]

이 Wikilinks는 파일에서 완전히 제거되며 해당 문서 URL 및 링크 유형은 현재 문서의 attributes 매터 변수 및 링크 된 문서의 attributed 매터 변수에 저장됩니다.

이러한 Wikilink 유형을 제거하는 것은 파일의 기본 콘텐츠와 분리 된 일부 형태의 인포 옥스를 만드는 시나리오에서 유용합니다.

Block Wikilinks는 파일 레벨에서만 작동하며 레이블이나 임베딩을 지원하지 않습니다. 설정을 통해 구성에서 토글링 될 수 있습니다.

 wikilinks:
  attributes: 
    enabled: false

헤더 레벨 Wikilinks

 [[ filename#header ]]

이 링크는 filename.md 라는 파일을 검색하고 # header 가있는 경우 링크를 검색합니다. 그러한 헤더가 존재하지 않으면, 그 결과 a 가 invalid-wiki-link CSS 클래스로 렌더링됩니다.

결과 HTML :

 < a class =" wiki-link " href =" url#sluggified-header-id " > lower-cased frontmatter title > header </ a >

블록 레벨 Wikilinks

 [[ filename#^block_id ]]

결과 HTML :

 < a class =" wiki-link " href =" url#block_id " > lower-cased title > ^block_id </ a >

대상 문서의 ^block_id 에 caret ^ 앞에 공간이 있는지 확인하십시오.
경고:
- ^block_id s 자체는 손길이 닿지 않으므로 페이지 문서에서 블록을 한 번 식별 할 수있는 방법이 있습니다.
- 블록은 헤더와 동일한 방식으로 처리됩니다. 즉, block_id URL 조각으로 추가됩니다 (예 : www.blog.com/wikilink/#block_id ). 이 URL 조각을 사용하면 해당 HTML 요소 ID에 대한 자동 스크롤을 활성화 할 수 있습니다. 지금은 HTML Elment ID를 수동으로 만들어야합니다.

파일 경로

TODO : 독특한 파일 이름이 여전히 예상됩니다. 이것은 결국 변경 될 것입니다.

 [[ /directory/filename ]]

파일 경로는 더 많은 특이성을 가진 파일을 가리키기 위해 링크에 추가 될 수 있습니다.

절대 경로는 전방 슬래시로 시작해야합니다 /
TODO : 상대 경로는 디렉토리 이름으로 시작해야합니다.

파일 경로는 인라인 Wikilinks에만 작동합니다.

결과 HTML (파일 경로가없는 Wikilinks와 동일하게 보일 것입니다) :

 < a class =" wiki-link " href =" url " > file's title </ a >

레이블 (때로는 '별명'이라고도 함)

 [[ filename|label text ]]

라벨을 사용할 때 | 문서의 title 프론트 매스터 대신 a 태그의 내부 텍스트로 렌더링됩니다.

라벨링은 모든 Wikilink 레벨 (파일, 헤더, 블록)에 대해 작동합니다.

결과 HTML :

 < a class =" wiki-link " href =" url " > label text </ a >

임베드

 ![ [ filename ]]

선불로 ! Wikilink 전에 파일의 내용은 a HTML 태그 만 삽입하지 않고 현재 문서에 내장됩니다.

임베드는 파일 레벨 wikilinks (헤더 또는 블록 아님)에만 작동합니다.

결과 HTML :

 < div class =" wiki-link-embed " >
  < div class =" wiki-link-embed-title " >
    // doc title here
  </ div >
  < div class =" wiki-link-embed-content " >
    // embed content here
  </ div >
  < a class =" wiki-link-embed-link " href =" url " > </ a >
</ div >

이미지를 포함시킵니다

 ![ [ image.png ]]

위의 내장과 마찬가지로 링크 내용은 문서 본문에서 렌더링됩니다. 파일 확장자를 추가하십시오. 지원되는 형식은 .png , .jpg , .gif , .psd , .svg 입니다. 이미지 Wikilinks는 메타 데이터에 포함되어 있지 않습니다.

결과 HTML :

 < p >
  < span class =" wiki-link-embed-image " >
    < img class =" wiki-link-img " src =" img_relative_path " />
  </ span >
</ p >

SVG의 컨텐츠는 img 태그에 연결되지 않고 HTML에 직접 삽입됩니다. 이것은 SVG Post-Render를 프로그래밍 방식으로 변경하려는 경우에 유용합니다.

결과 HTML :

 < p >
  < span class =" wiki-link-embed-image " >
    < svg >
      // svg file content here
    </ svg >
  </ span >
</ p >

더 많은 구문

== Highlights == 및 ~~ Strikethroughs와 같은 더 많은 음표 관련 구문 ~~ :

Kramdown의 경우 프로젝트 페이지 (강조 표시, Strikethrough 티켓)를 확인하십시오.
지금 기능하는 것은 레드 카펫 마크 다운 파서를 참조하십시오.

메타 데이터

다음 메타 데이터는 프론트 마터 변수로 저장되며 액체 템플릿에서 액세스 할 수 있습니다.

attributed (블록 백 링크)
attributes (Block Forelinks)
backlinks (유형 및 미지급, 파일/헤더/블록, 백 링크)
forelinks (유형 및 Untyped, 파일/헤더/블록, '전방'링크)
missing (유형 및 Unttyped, 파일/헤더/블록, 문서에 해당하지 않는 Forelinks)

블록 Wikilink (속성) 메타 데이터

Wikilinks 블록에 해당하는 attributes 및 attributed 프론트 마터 변수는 Wikilink 유형의 type 속성과 urls 목록이있는 객체 목록입니다.

-
  type : <str>
  urls : [<url_str>]
-
  ...

예제 액체 :

 <!-- render as  "link-type: title" -->

{% for attr in page.attributed %}
  {{ attr.type }}:
  {% for url in attr.urls %}
      {% assign linked_doc = site.documents | where: "url", attr.url | first %}
      < a class =" wiki-link " href =" {{ linked_doc.url }} " > {{ linked_doc.title }} </ a >
   {% endfor %}
{% endfor %}

인라인 Wikilink 메타 데이터

인라인 Wikilinks에 해당하는 forelinks 및 backlinks 전면 매트 변수는 Wikilink 유형 및 url 문자열에 대한 type 속성이있는 개체 목록입니다. (Untyped wikilinks는 빈 속성이 있습니다 : type: "" ) :

-
  type : <str>
  url : <url_str>
-
  ...

예제 액체 :

 <!-- render as  "link-type: title" -->

{% for backlink in page.backlinks %}
  {% assign linked_doc = site.documents | where: "url", backlink.url | first %}
  {{ backlink.type }}: < a class =" wiki-link " href =" {{ linked_doc.url }} " > {{ linked_doc.title }} </ a >
{% endfor %}

메타 데이터 누락

missing 단순히 파일 이름 목록입니다. 블록 레벨 및 인라인 레벨 Wikilinks의 파일 이름이 수집됩니다.

- <filename_str>
- ...

액체 필터

제공된 액체 필터에는 두 가지 유형의 액체 필터가 있습니다. 하나는 Jekyll 문서 유형과 링크 (관계) 유형 용입니다.

Jekyll 문서 유형으로 필터링하고 싶다고 가정 해 봅시다. 'Post'백 링크 및 '참고'백 링크를 별도로 표시하려면 백 링크 메타 데이터를 필터링하기 만하면 다음과 같습니다.

 <!-- show post backlink titles -->
{% assign post_backlinks = page.backlinks | doc_type: "posts" %}
{% for backlink in post_backlinks %}
  {% assign post = site.posts | where: "url", backlink | first %}
  {{ post.title }}
{% endfor %}

<!-- show note backlink titles -->
{% assign note_backlinks = page.backlinks | doc_type: "notes" %}
{% for backlink in note_backlinks %}
  {% assign note = site.notes | where: "url", backlink | first %}
  {{ note.title }}
{% endfor %}

링크 (관계) 유형별로 필터링하고 싶다고 가정 해 봅시다. 다음과 같은 마크 다운이있는 경우 :

author:: [[ gardener ]]

그런 다음 author 유형별로 필터링 할 수 있습니다.

{% assign author_links = page.links | link_type: "author" %}
{% for link in author_links %}
  {% assign post = site.posts | where: "url", link.url | first %}
  {{ post.title }}
{% endfor %}

다른 구현 ...

... 그것은 Jekyll 관련입니다

순수한 액체 임플란치
Jekyll 변환기
또 다른 Jekyll 변환기
템플릿

... 그것은 위키 관련입니다

골룸
위키 클로스

확장하다

추가 정보

버전 1.0.0
유형 기타 카테고리
업데이트 시간 2025-03-25
크기 99.52KB
출처 Github

jekyll wikilinks