Skip to content

Multiple languages by tab?  #54

New issue
New issue
Open
#55
Open
Multiple languages by tab? #54
#55
@maelle

Description

@maelle
maelle
opened on May 9, 2020

Thanks for creating this useful theme!

I have a question that might be a limitation of Slatedocs itself.

I'd like to be able to define tabs that show several languages.

For instance, for documenting a web API that has an R client providing parsed output

  • A tab with R code and R output
  • A tab with shell commands and JSON/XML output.

My workaround is to define the second tab for "JavaScript" because highlighting shell/JSON/XML as if it were JavaScript does not look too horrible.

Any insight on how to tweak this theme to be able to use something like

[[params.language_tabs]]
  key = "r"
  name = "R" 
[[params.language_tabs]]
  key = "shell"
  name = "Shell"
  otherlangs = ["json", "xml"]

is welcome. 🙂 I guess I'd need to tinker with https://github.com/bep/docuapi/blob/master/assets/js/slate/app/_lang.js and

docuapi/layouts/_default/baseof.html

Line 25 in fc2d3f5

<a href="#" data-language-name="{{ .key }}">{{ .name }}</a>
(where there could be, say, data-language-name and data-languages-name, one for the URL stuff -- key, one for the hiding/showing -- key+otherlangs 🤔) and

docuapi/layouts/_default/baseof.html

Line 12 in fc2d3f5

<body class="index" data-languages="{{ with .Site.Params.language_tabs }}[{{ range $i,$e := . }}{{- if $i -}}, {{ end -}}{{ printf " %q " $e.key }}{{end}}]{{ end }}">
(that'd use key and otherlangs in my "proposal").

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions