xigoi / xidoc Goto Github PK

There are commands for easily displaying theorems, proofs, and definitions.

However, when writing lecture notes I find myself often writing some simple lemmata. I feel like it would be natural to have a command similar to [dfn ] for lemmata :)

it must be so fking dumb but can i have ur discord if u don't have one, that fine, i just wanna ask u something on private message

This is an idea for an enhancement.

As far as I know there is no ordered list feature. However sometimes I find myself needing to write cookbook-like set of instructions that ought to be followed in a specific order. Here it would make sense to have it.

Hi Adam (@xigoi),

The Commands reference document is quite long. Might it be possible to include a Table of Contents (based on the "h2" headings), like the following:

• Introduction
• Top-level commands
• HTML commands
• CSS commands
• Math commands

This will give the reader an overview of the content before they get caught up in the technical details. The document is well-written and comprehensive. Therefore, I believe, that a Table of Contents would make it easier to approach for a new user.

Kind Regards,
Liam

Also, how to do a bold italic text?

;[ or /[ or \[ or [[
;] or /] or \] or ]]
(the ; without a space afterwards is a rare typing occurrence and is the most convenient due to the home row position of ;)
... instead of the current 3-char implementation [(]
Would those break anything fundamental in parsing?

Suggestion: Add a GitHub link to the website http://xidoc.nim.town.

Hi Adam (@xigoi),

When you have the opportunity, perhaps you could consider the following GitHub repos for possible ideas that could be included in XiDoc?

Practical Markup Language (PML)

I'm guessing that one of the influences on your markup syntax is from Arturo, where it uses square brackets to delimit blocks.

Interestingly, PML is similar, as seen on the home page. The rationale behind the markup language is explained in the FAQ and the User Manual gives a quick overview of the language.

I have used PML in the past and when I came across XiDoc, I was struck by the similarities. Perhaps there might be some ideas that you might be able to glean and add to your own markup?

HastyScribe

Like Aturo and XiDoc, HastyScribe is written in Nim. It takes Markdown (with some modifications) and creates a standalone self-contained HTML output. One of the things you might want to look at is how HastyScribe embeds all images in the HTML output. The Introduction to HastyScribe again might give you some ideas.

I am only beginning to look at XiDoc and I trust that these suggestions will help either generate some ideas or else point you towards some code that you can incorporate into your own markup.

Kind Regards,
Liam

Hi,

I noticed the following issue when using code-block:

I have the following piece of code that I'd like to display in python formatting:

[code-block python;
	[raw
		X = np.arange(-10, 10, 1.5)
		Y = np.arange(-10, 10, 1.5)
		X, Y = np.meshgrid(X, Y)
	]
]

However, when I try to compile this in xidoc it gives me:

Unknown language for syntax highlighting: python

It used to work fine. But it broke after I reinstalled xidoc with the command

nimble install xidoc

I might have messed something up during the reinstall, my understanding of nimble is very limited. Also it works fine when I remove the ?language specifier.

Edit:
The same problem is also with the example from the webpage:

[code-block javascript; [raw
const factorial = (n) => {
  let result = 1n;
  for (let i = 1; i <= n; i++) {
    result *= BigInt(i);
  }
  return result;
}
]]

also fails so it's not just python-highlighting issue.