@brainpilot/skills 0.0.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.ts +6 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +28 -0
- package/dist/index.js.map +1 -0
- package/package.json +35 -0
- package/skills/01_Meta-Skills/contribute-skill/SKILL.md +277 -0
- package/skills/01_Meta-Skills/contribute-skills-via-pr/SKILL.md +163 -0
- package/skills/01_Meta-Skills/paper-to-skill/SKILL.md +435 -0
- package/skills/01_Meta-Skills/paper-to-skill/references/extraction-guide.md +286 -0
- package/skills/01_Meta-Skills/paper-to-skill/references/skill-template.md +250 -0
- package/skills/01_Meta-Skills/repo-to-skill/SKILL.md +289 -0
- package/skills/01_Meta-Skills/share-case/SKILL.md +253 -0
- package/skills/01_Meta-Skills/share-usage/README.md +63 -0
- package/skills/01_Meta-Skills/share-usage/SKILL.md +395 -0
- package/skills/01_Meta-Skills/verify-skill/SKILL.md +331 -0
- package/skills/02_Cross-Domain_Foundation/cogsci-power-analysis/SKILL.md +194 -0
- package/skills/02_Cross-Domain_Foundation/cogsci-power-analysis/references/effect-sizes.md +352 -0
- package/skills/02_Cross-Domain_Foundation/cogsci-power-analysis/references/sample-size-guide.md +407 -0
- package/skills/02_Cross-Domain_Foundation/cogsci-statistics/SKILL.md +361 -0
- package/skills/02_Cross-Domain_Foundation/cogsci-statistics/references/common-analyses.md +517 -0
- package/skills/02_Cross-Domain_Foundation/cogsci-visualization/SKILL.md +292 -0
- package/skills/02_Cross-Domain_Foundation/cogsci-visualization/references/plot-recipes.md +709 -0
- package/skills/02_Cross-Domain_Foundation/research-literacy/SKILL.md +286 -0
- package/skills/02_Cross-Domain_Foundation/research-literacy/references/common-assumptions.md +320 -0
- package/skills/02_Cross-Domain_Foundation/research-literacy/references/planning-template.md +143 -0
- package/skills/03_Cognitive_Psychology/alternative-uses-task-designer/SKILL.md +197 -0
- package/skills/03_Cognitive_Psychology/alternative-uses-task-designer/references/instruction-templates.md +60 -0
- package/skills/03_Cognitive_Psychology/cognitive-paradigm-design/SKILL.md +246 -0
- package/skills/03_Cognitive_Psychology/cognitive-paradigm-design/references/classic-paradigms.md +435 -0
- package/skills/03_Cognitive_Psychology/cognitive-paradigm-design/references/design-principles.md +256 -0
- package/skills/03_Cognitive_Psychology/creativity-self-efficacy-mediation/SKILL.md +270 -0
- package/skills/03_Cognitive_Psychology/creativity-self-efficacy-mediation/references/lavaan-templates.md +172 -0
- package/skills/03_Cognitive_Psychology/divergent-thinking-scoring/SKILL.md +238 -0
- package/skills/03_Cognitive_Psychology/divergent-thinking-scoring/references/scoring-rubric.md +143 -0
- package/skills/03_Cognitive_Psychology/drift-diffusion-model/SKILL.md +203 -0
- package/skills/03_Cognitive_Psychology/drift-diffusion-model/references/fitting-guide.md +571 -0
- package/skills/03_Cognitive_Psychology/drift-diffusion-model/references/model-variants.md +427 -0
- package/skills/03_Cognitive_Psychology/evidence-accumulation-selector/SKILL.md +310 -0
- package/skills/03_Cognitive_Psychology/evidence-accumulation-selector/references/ez-diffusion-formulas.md +137 -0
- package/skills/03_Cognitive_Psychology/signal-detection-analysis/SKILL.md +300 -0
- package/skills/03_Cognitive_Psychology/signal-detection-analysis/references/application-guide.md +278 -0
- package/skills/03_Cognitive_Psychology/signal-detection-analysis/references/sdt-formulas.md +318 -0
- package/skills/03_Cognitive_Psychology/visual-search-array-generator/SKILL.md +283 -0
- package/skills/03_Cognitive_Psychology/visual-search-array-generator/references/array-generation-parameters.yaml +111 -0
- package/skills/04_Psycholinguistics/reading-time-analysis/SKILL.md +301 -0
- package/skills/04_Psycholinguistics/reading-time-analysis/references/measure-computation-guide.md +195 -0
- package/skills/04_Psycholinguistics/self-paced-reading-designer/SKILL.md +257 -0
- package/skills/04_Psycholinguistics/self-paced-reading-designer/references/analysis-guide.md +356 -0
- package/skills/04_Psycholinguistics/self-paced-reading-designer/references/region-segmentation.md +266 -0
- package/skills/04_Psycholinguistics/sentence-stimulus-norming/SKILL.md +346 -0
- package/skills/04_Psycholinguistics/sentence-stimulus-norming/references/lexical-databases-guide.md +184 -0
- package/skills/05_EEG_ERP/eeg-paradigm-designer/SKILL.md +226 -0
- package/skills/05_EEG_ERP/eeg-paradigm-designer/references/component-paradigm-map.md +276 -0
- package/skills/05_EEG_ERP/eeg-paradigm-designer/references/timing-parameters.md +244 -0
- package/skills/05_EEG_ERP/eeg-preprocessing-pipeline-guide/SKILL.md +367 -0
- package/skills/05_EEG_ERP/eeg-preprocessing-pipeline-guide/references/parameter-lookup-tables.md +138 -0
- package/skills/05_EEG_ERP/erp-analysis/SKILL.md +185 -0
- package/skills/05_EEG_ERP/erp-analysis/references/erp-components.md +447 -0
- package/skills/05_EEG_ERP/erp-analysis/references/preprocessing-pipeline.md +277 -0
- package/skills/05_EEG_ERP/erp-analysis/references/statistical-approaches.md +351 -0
- package/skills/05_EEG_ERP/mne-python-guide/SKILL.md +174 -0
- package/skills/05_EEG_ERP/mne-python-guide/references/decoding.md +178 -0
- package/skills/05_EEG_ERP/mne-python-guide/references/io_formats.md +160 -0
- package/skills/05_EEG_ERP/mne-python-guide/references/preprocessing.md +259 -0
- package/skills/05_EEG_ERP/mne-python-guide/references/simulation.md +173 -0
- package/skills/05_EEG_ERP/mne-python-guide/references/source_localization.md +234 -0
- package/skills/05_EEG_ERP/mne-python-guide/references/statistics.md +196 -0
- package/skills/05_EEG_ERP/mne-python-guide/references/time_frequency.md +165 -0
- package/skills/05_EEG_ERP/mne-python-guide/references/visualization.md +175 -0
- package/skills/06_fMRI_Neuroimaging/brain-connectivity-modeler/SKILL.md +317 -0
- package/skills/06_fMRI_Neuroimaging/brain-connectivity-modeler/references/method-implementation-guide.md +116 -0
- package/skills/06_fMRI_Neuroimaging/fmri-glm-analysis-guide/SKILL.md +296 -0
- package/skills/06_fMRI_Neuroimaging/fmri-glm-analysis-guide/references/design-matrix-guide.md +214 -0
- package/skills/06_fMRI_Neuroimaging/fmri-glm-analysis-guide/references/statistical-inference.md +288 -0
- package/skills/06_fMRI_Neuroimaging/fmri-preprocessing-pipeline-guide/SKILL.md +274 -0
- package/skills/06_fMRI_Neuroimaging/fmri-preprocessing-pipeline-guide/references/quality-control.md +336 -0
- package/skills/06_fMRI_Neuroimaging/fmri-preprocessing-pipeline-guide/references/step-by-step-pipeline.md +380 -0
- package/skills/06_fMRI_Neuroimaging/fmri-task-design-guide/SKILL.md +264 -0
- package/skills/06_fMRI_Neuroimaging/fmri-task-design-guide/references/design-optimization-examples.md +114 -0
- package/skills/06_fMRI_Neuroimaging/neural-decoding-analysis/SKILL.md +273 -0
- package/skills/06_fMRI_Neuroimaging/neural-decoding-analysis/references/decoding-methods.md +170 -0
- package/skills/06_fMRI_Neuroimaging/neural-decoding-analysis/references/rsa-guide.md +266 -0
- package/skills/06_fMRI_Neuroimaging/pycortex-guide/SKILL.md +123 -0
- package/skills/06_fMRI_Neuroimaging/pycortex-guide/references/database-subjects.md +179 -0
- package/skills/06_fMRI_Neuroimaging/pycortex-guide/references/dataset-types.md +208 -0
- package/skills/06_fMRI_Neuroimaging/pycortex-guide/references/freesurfer-fmriprep.md +162 -0
- package/skills/06_fMRI_Neuroimaging/pycortex-guide/references/mapping-transforms.md +181 -0
- package/skills/06_fMRI_Neuroimaging/pycortex-guide/references/mni-utils.md +207 -0
- package/skills/06_fMRI_Neuroimaging/pycortex-guide/references/surface-analysis.md +219 -0
- package/skills/06_fMRI_Neuroimaging/pycortex-guide/references/visualization.md +251 -0
- package/skills/07_Computational_Modeling/act-r-model-builder/SKILL.md +297 -0
- package/skills/07_Computational_Modeling/act-r-model-builder/references/model-patterns.md +197 -0
- package/skills/07_Computational_Modeling/act-r-model-builder/references/parameter-table.yaml +204 -0
- package/skills/07_Computational_Modeling/bayesian-cognitive-model-builder/SKILL.md +294 -0
- package/skills/07_Computational_Modeling/bayesian-cognitive-model-builder/references/diagnostics-checklist.md +351 -0
- package/skills/07_Computational_Modeling/bayesian-cognitive-model-builder/references/prior-selection-guide.md +241 -0
- package/skills/07_Computational_Modeling/parameter-recovery-checker/SKILL.md +269 -0
- package/skills/07_Computational_Modeling/parameter-recovery-checker/references/recovery-diagnostics.md +207 -0
- package/skills/08_Computational_Neuroscience/brain-connectivity-modeler/SKILL.md +317 -0
- package/skills/08_Computational_Neuroscience/brain-connectivity-modeler/references/method-implementation-guide.md +116 -0
- package/skills/08_Computational_Neuroscience/neural-decoding-analysis/SKILL.md +273 -0
- package/skills/08_Computational_Neuroscience/neural-decoding-analysis/references/decoding-methods.md +170 -0
- package/skills/08_Computational_Neuroscience/neural-decoding-analysis/references/rsa-guide.md +266 -0
- package/skills/08_Computational_Neuroscience/neural-population-analysis-guide/SKILL.md +305 -0
- package/skills/08_Computational_Neuroscience/neural-population-analysis-guide/references/data-requirements.md +60 -0
- package/skills/08_Computational_Neuroscience/neural-population-analysis-guide/references/method-comparison.md +151 -0
- package/skills/08_Computational_Neuroscience/spiking-network-model-builder/SKILL.md +376 -0
- package/skills/08_Computational_Neuroscience/spiking-network-model-builder/references/hh-parameters.md +117 -0
- package/skills/08_Computational_Neuroscience/spiking-network-model-builder/references/network-regimes.md +130 -0
- package/skills/09_Cellular_Molecular_Neuroscience/calcium-imaging-analysis-guide/SKILL.md +258 -0
- package/skills/09_Cellular_Molecular_Neuroscience/calcium-imaging-analysis-guide/references/indicator-parameters.md +242 -0
- package/skills/09_Cellular_Molecular_Neuroscience/calcium-imaging-analysis-guide/references/pipeline-details.md +211 -0
- package/skills/09_Cellular_Molecular_Neuroscience/optogenetics-protocol-designer/SKILL.md +261 -0
- package/skills/09_Cellular_Molecular_Neuroscience/optogenetics-protocol-designer/references/opsin-catalog.md +124 -0
- package/skills/09_Cellular_Molecular_Neuroscience/optogenetics-protocol-designer/references/stimulation-parameters.md +304 -0
- package/skills/10_Clinical_Neuropsychology/lesion-symptom-mapping-guide/SKILL.md +367 -0
- package/skills/10_Clinical_Neuropsychology/lesion-symptom-mapping-guide/references/disconnection-guide.md +152 -0
- package/skills/10_Clinical_Neuropsychology/lesion-symptom-mapping-guide/references/vlsm-pipeline.md +182 -0
- package/skills/10_Clinical_Neuropsychology/neuropsych-battery-selector/SKILL.md +250 -0
- package/skills/10_Clinical_Neuropsychology/neuropsych-battery-selector/references/deficit-profiles.md +302 -0
- package/skills/10_Clinical_Neuropsychology/neuropsych-battery-selector/references/test-catalog.md +304 -0
- package/skills/11_Developmental_Cognition/infant-looking-time-designer/SKILL.md +345 -0
- package/skills/11_Developmental_Cognition/infant-looking-time-designer/references/age-parameters.yaml +186 -0
- package/skills/12_Social_Cognition/tom-task-selector/SKILL.md +379 -0
- package/skills/12_Social_Cognition/tom-task-selector/references/task-database.md +317 -0
- package/skills/13_Visualization/nature-figure/README.md +442 -0
- package/skills/13_Visualization/nature-figure/SKILL.md +60 -0
- package/skills/13_Visualization/nature-figure/assets/chart-atlas/atlas-01-bar-charts.png +0 -0
- package/skills/13_Visualization/nature-figure/assets/chart-atlas/atlas-02-line-trends.png +0 -0
- package/skills/13_Visualization/nature-figure/assets/chart-atlas/atlas-03-heatmaps.png +0 -0
- package/skills/13_Visualization/nature-figure/assets/chart-atlas/atlas-04-scatter-bubble.png +0 -0
- package/skills/13_Visualization/nature-figure/assets/chart-atlas/atlas-05-radar-polar.png +0 -0
- package/skills/13_Visualization/nature-figure/assets/chart-atlas/atlas-06-distributions.png +0 -0
- package/skills/13_Visualization/nature-figure/assets/chart-atlas/atlas-07-forest-interval.png +0 -0
- package/skills/13_Visualization/nature-figure/assets/chart-atlas/atlas-08-area-stacked.png +0 -0
- package/skills/13_Visualization/nature-figure/assets/chart-atlas/atlas-09-image-plates.png +0 -0
- package/skills/13_Visualization/nature-figure/assets/chart-atlas/atlas-10-network-matrix.png +0 -0
- package/skills/13_Visualization/nature-figure/assets/figures4papers/assets/Dispersion_motivation.png +0 -0
- package/skills/13_Visualization/nature-figure/assets/figures4papers/assets/Dispersion_observation.png +0 -0
- package/skills/13_Visualization/nature-figure/assets/figures4papers/assets/Dispersion_observation_distillation.png +0 -0
- package/skills/13_Visualization/nature-figure/assets/figures4papers/assets/ImmunoStruct_contrastive.png +0 -0
- package/skills/13_Visualization/nature-figure/assets/figures4papers/assets/ImmunoStruct_results_CEDAR.png +0 -0
- package/skills/13_Visualization/nature-figure/assets/figures4papers/assets/ImmunoStruct_results_IEDB.png +0 -0
- package/skills/13_Visualization/nature-figure/assets/figures4papers/assets/ImmunoStruct_schematic.png +0 -0
- package/skills/13_Visualization/nature-figure/assets/figures4papers/assets/RNAGenScape_schematic.png +0 -0
- package/skills/13_Visualization/nature-figure/assets/figures4papers/figure_CellSpliceNet/figures/ablation.png +0 -0
- package/skills/13_Visualization/nature-figure/assets/figures4papers/figure_CellSpliceNet/figures/comparison.png +0 -0
- package/skills/13_Visualization/nature-figure/assets/figures4papers/figure_CellSpliceNet/plot_ablation.py +86 -0
- package/skills/13_Visualization/nature-figure/assets/figures4papers/figure_CellSpliceNet/plot_comparison.py +109 -0
- package/skills/13_Visualization/nature-figure/assets/figures4papers/figure_Cflows/diffusion_swiss_roll.py +97 -0
- package/skills/13_Visualization/nature-figure/assets/figures4papers/figure_Cflows/figures/diffusion_swiss_roll.png +0 -0
- package/skills/13_Visualization/nature-figure/assets/figures4papers/figure_Cflows/figures/fig2_comparison_GeneRegulatory.pdf +0 -0
- package/skills/13_Visualization/nature-figure/assets/figures4papers/figure_Cflows/figures/fig2_comparison_GeneRegulatory.png +0 -0
- package/skills/13_Visualization/nature-figure/assets/figures4papers/figure_Cflows/figures/fig2_comparison_Trajectory.pdf +0 -0
- package/skills/13_Visualization/nature-figure/assets/figures4papers/figure_Cflows/figures/fig2_comparison_Trajectory.png +0 -0
- package/skills/13_Visualization/nature-figure/assets/figures4papers/figure_Cflows/figures/figX_comparison_Ablation.pdf +0 -0
- package/skills/13_Visualization/nature-figure/assets/figures4papers/figure_Cflows/figures/figX_comparison_Ablation.png +0 -0
- package/skills/13_Visualization/nature-figure/assets/figures4papers/figure_Cflows/plot_comparison_Ablation.py +64 -0
- package/skills/13_Visualization/nature-figure/assets/figures4papers/figure_Cflows/plot_comparison_GeneRegulatory.py +74 -0
- package/skills/13_Visualization/nature-figure/assets/figures4papers/figure_Cflows/plot_comparison_Trajectory.py +74 -0
- package/skills/13_Visualization/nature-figure/assets/figures4papers/figure_Dispersion/figures/idea.png +0 -0
- package/skills/13_Visualization/nature-figure/assets/figures4papers/figure_Dispersion/figures/illustration.png +0 -0
- package/skills/13_Visualization/nature-figure/assets/figures4papers/figure_Dispersion/plot_idea.py +76 -0
- package/skills/13_Visualization/nature-figure/assets/figures4papers/figure_Dispersion/plot_illustration.py +404 -0
- package/skills/13_Visualization/nature-figure/assets/figures4papers/figure_FPGM/figures/freq_prior.png +0 -0
- package/skills/13_Visualization/nature-figure/assets/figures4papers/figure_FPGM/plot_freq_prior.py +146 -0
- package/skills/13_Visualization/nature-figure/assets/figures4papers/figure_ImmunoStruct/figures/bars_ablation_Cancer.png +0 -0
- package/skills/13_Visualization/nature-figure/assets/figures4papers/figure_ImmunoStruct/figures/bars_ablation_IEDB.png +0 -0
- package/skills/13_Visualization/nature-figure/assets/figures4papers/figure_ImmunoStruct/figures/bars_comparison_Cancer.png +0 -0
- package/skills/13_Visualization/nature-figure/assets/figures4papers/figure_ImmunoStruct/figures/bars_comparison_IEDB.png +0 -0
- package/skills/13_Visualization/nature-figure/assets/figures4papers/figure_ImmunoStruct/plot_bars.py +216 -0
- package/skills/13_Visualization/nature-figure/assets/figures4papers/figure_ImmunoStruct/raw_data.py +125 -0
- package/skills/13_Visualization/nature-figure/assets/figures4papers/figure_RNAGenScape/figures/manifold.png +0 -0
- package/skills/13_Visualization/nature-figure/assets/figures4papers/figure_RNAGenScape/figures/manifold_holes.png +0 -0
- package/skills/13_Visualization/nature-figure/assets/figures4papers/figure_RNAGenScape/figures/results_comparison_optimization.png +0 -0
- package/skills/13_Visualization/nature-figure/assets/figures4papers/figure_RNAGenScape/figures/results_comparison_speed.png +0 -0
- package/skills/13_Visualization/nature-figure/assets/figures4papers/figure_RNAGenScape/figures/results_sweep.png +0 -0
- package/skills/13_Visualization/nature-figure/assets/figures4papers/figure_RNAGenScape/plot_comparison.py +228 -0
- package/skills/13_Visualization/nature-figure/assets/figures4papers/figure_RNAGenScape/plot_hole_manifold.py +82 -0
- package/skills/13_Visualization/nature-figure/assets/figures4papers/figure_RNAGenScape/plot_manifold.py +61 -0
- package/skills/13_Visualization/nature-figure/assets/figures4papers/figure_RNAGenScape/plot_sweep.py +77 -0
- package/skills/13_Visualization/nature-figure/assets/figures4papers/figure_VIGIL/figures/comparison_posttraining.png +0 -0
- package/skills/13_Visualization/nature-figure/assets/figures4papers/figure_VIGIL/figures/comparison_radar.png +0 -0
- package/skills/13_Visualization/nature-figure/assets/figures4papers/figure_VIGIL/plot_comparison_radar.py +173 -0
- package/skills/13_Visualization/nature-figure/assets/figures4papers/figure_VIGIL/plot_posttraining.py +82 -0
- package/skills/13_Visualization/nature-figure/assets/figures4papers/figure_brainteaser/figures/brute_force.png +0 -0
- package/skills/13_Visualization/nature-figure/assets/figures4papers/figure_brainteaser/figures/correctness_by_category.png +0 -0
- package/skills/13_Visualization/nature-figure/assets/figures4papers/figure_brainteaser/figures/correctness_by_subcategory.png +0 -0
- package/skills/13_Visualization/nature-figure/assets/figures4papers/figure_brainteaser/figures/rewriting.png +0 -0
- package/skills/13_Visualization/nature-figure/assets/figures4papers/figure_brainteaser/figures/selfcorrection_math.png +0 -0
- package/skills/13_Visualization/nature-figure/assets/figures4papers/figure_brainteaser/plot_brute_force.py +248 -0
- package/skills/13_Visualization/nature-figure/assets/figures4papers/figure_brainteaser/plot_correctness_by_category.py +132 -0
- package/skills/13_Visualization/nature-figure/assets/figures4papers/figure_brainteaser/plot_correctness_by_subcategory.py +131 -0
- package/skills/13_Visualization/nature-figure/assets/figures4papers/figure_brainteaser/plot_rewriting.py +105 -0
- package/skills/13_Visualization/nature-figure/assets/figures4papers/figure_brainteaser/plot_selfcorrection_math.py +99 -0
- package/skills/13_Visualization/nature-figure/assets/figures4papers/figure_ophthal_review/figures/composition_heatmap.png +0 -0
- package/skills/13_Visualization/nature-figure/assets/figures4papers/figure_ophthal_review/figures/trend_by_month.png +0 -0
- package/skills/13_Visualization/nature-figure/assets/figures4papers/figure_ophthal_review/plot_composition.py +81 -0
- package/skills/13_Visualization/nature-figure/assets/figures4papers/figure_ophthal_review/plot_trend.py +125 -0
- package/skills/13_Visualization/nature-figure/assets/gallery/fig1-material-mechanism-rich.png +0 -0
- package/skills/13_Visualization/nature-figure/assets/gallery/fig2-spatial-imaging-rich.png +0 -0
- package/skills/13_Visualization/nature-figure/assets/gallery/fig3-in-vivo-efficacy-rich.png +0 -0
- package/skills/13_Visualization/nature-figure/assets/gallery/fig4-single-cell-systems-rich.png +0 -0
- package/skills/13_Visualization/nature-figure/assets/gallery/fig5-validation-perturbation-rich.png +0 -0
- package/skills/13_Visualization/nature-figure/evals/evals.json +37 -0
- package/skills/13_Visualization/nature-figure/manifest.yaml +57 -0
- package/skills/13_Visualization/nature-figure/references/api.md +428 -0
- package/skills/13_Visualization/nature-figure/references/backend-selection.md +100 -0
- package/skills/13_Visualization/nature-figure/references/chart-types.md +281 -0
- package/skills/13_Visualization/nature-figure/references/common-patterns.md +350 -0
- package/skills/13_Visualization/nature-figure/references/demos.md +65 -0
- package/skills/13_Visualization/nature-figure/references/design-theory.md +436 -0
- package/skills/13_Visualization/nature-figure/references/figure-contract.md +93 -0
- package/skills/13_Visualization/nature-figure/references/nature-2026-observations.md +112 -0
- package/skills/13_Visualization/nature-figure/references/qa-contract.md +119 -0
- package/skills/13_Visualization/nature-figure/references/r-template-index.md +66 -0
- package/skills/13_Visualization/nature-figure/references/r-workflow.md +161 -0
- package/skills/13_Visualization/nature-figure/references/tutorials.md +251 -0
- package/skills/13_Visualization/nature-figure/static/core/contract.md +29 -0
- package/skills/13_Visualization/nature-figure/static/core/stance.md +37 -0
- package/skills/13_Visualization/nature-figure/static/fragments/backend/python.md +37 -0
- package/skills/13_Visualization/nature-figure/static/fragments/backend/r.md +44 -0
- package/skills/14_Writing/markdown-report-writing/SKILL.md +306 -0
- package/skills/14_Writing/markdown-report-writing/references/compatibility-matrix.md +72 -0
- package/skills/14_Writing/markdown-report-writing/references/templates.md +299 -0
- package/skills/15_Others/neuroimaging-power-guide/SKILL.md +324 -0
- package/skills/15_Others/neuroimaging-power-guide/references/effect-size-lookup-tables.md +102 -0
- package/skills/15_Others/neuroimaging-sample-size-calculator/SKILL.md +330 -0
- package/skills/15_Others/neuroimaging-sample-size-calculator/references/worked-examples.md +220 -0
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
# Backend: Python (matplotlib / seaborn)
|
|
2
|
+
|
|
3
|
+
**Python-only execution rule.** When the user has selected Python, do all figure drawing, previewing, exporting, and visual QA in Python. Do not call R/ggplot2, ComplexHeatmap, patchwork, or any R graphics device to create a temporary preview, fallback export, or layout approximation. If Python or required Python plotting packages are missing, stop before rendering and report the missing dependency. You may still write the Python script, provide `pip`/environment install commands, or ask permission to install dependencies, but do not cross-render the figure in R.
|
|
4
|
+
|
|
5
|
+
## Python quick-start
|
|
6
|
+
|
|
7
|
+
```python
|
|
8
|
+
import matplotlib as mpl
|
|
9
|
+
import matplotlib.pyplot as plt
|
|
10
|
+
|
|
11
|
+
mpl.rcParams.update({
|
|
12
|
+
"font.family": "sans-serif",
|
|
13
|
+
"font.sans-serif": ["Arial", "Helvetica", "DejaVu Sans", "sans-serif"],
|
|
14
|
+
"svg.fonttype": "none", # editable text in SVG
|
|
15
|
+
"pdf.fonttype": 42, # editable TrueType text in PDF
|
|
16
|
+
"font.size": 7, # use 15-24 only for large slide-sized panels
|
|
17
|
+
"axes.spines.right": False,
|
|
18
|
+
"axes.spines.top": False,
|
|
19
|
+
"axes.linewidth": 0.8,
|
|
20
|
+
"legend.frameon": False,
|
|
21
|
+
})
|
|
22
|
+
|
|
23
|
+
def save_pub_py(fig, filename, dpi=600):
|
|
24
|
+
fig.savefig(f"{filename}.svg", bbox_inches="tight")
|
|
25
|
+
fig.savefig(f"{filename}.pdf", bbox_inches="tight")
|
|
26
|
+
fig.savefig(f"{filename}.tiff", dpi=dpi, bbox_inches="tight")
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
Use `text.usetex = True` only when LaTeX is installed and math-rich labels are required.
|
|
30
|
+
|
|
31
|
+
## Going deeper
|
|
32
|
+
|
|
33
|
+
- `references/api.md` — Python PALETTE, helper function signatures, validation rules.
|
|
34
|
+
- `references/common-patterns.md` — hero panels, legend-only axes, dark image plates, asymmetric layouts.
|
|
35
|
+
- `references/chart-types.md` — radar, 3D sphere, fill_between, scatter patterns.
|
|
36
|
+
- `references/tutorials.md` — end-to-end walkthroughs for bars, trends, heatmaps.
|
|
37
|
+
- `references/demos.md` — bundled figures4papers Python scripts and output previews.
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
# Backend: R (ggplot2 / patchwork / ComplexHeatmap)
|
|
2
|
+
|
|
3
|
+
**R-only execution rule.** When the user has selected R, do all figure drawing, previewing, exporting, and visual QA in R. Do not call matplotlib/seaborn or any Python graphics device to create a temporary preview, fallback export, or layout approximation. If `Rscript`/R or required R packages are missing, stop before rendering and report the exact blocker. You may still write the R script, provide install commands (for example `install.packages(...)`), or ask permission to install dependencies, but do not cross-render the figure in Python.
|
|
4
|
+
|
|
5
|
+
## R quick-start
|
|
6
|
+
|
|
7
|
+
```r
|
|
8
|
+
library(ggplot2)
|
|
9
|
+
library(patchwork)
|
|
10
|
+
|
|
11
|
+
theme_set(
|
|
12
|
+
theme_classic(base_size = 6.5, base_family = "Arial") +
|
|
13
|
+
theme(
|
|
14
|
+
axis.line = element_line(linewidth = 0.35, colour = "black"),
|
|
15
|
+
axis.ticks = element_line(linewidth = 0.35, colour = "black"),
|
|
16
|
+
legend.title = element_text(size = 6.2),
|
|
17
|
+
legend.text = element_text(size = 5.8),
|
|
18
|
+
strip.text = element_text(size = 6.2, face = "bold"),
|
|
19
|
+
plot.title = element_text(size = 7, face = "bold"),
|
|
20
|
+
panel.grid = element_blank()
|
|
21
|
+
)
|
|
22
|
+
)
|
|
23
|
+
|
|
24
|
+
save_pub_r <- function(plot, filename, width_mm = 183, height_mm = 120, dpi = 600) {
|
|
25
|
+
w <- width_mm / 25.4
|
|
26
|
+
h <- height_mm / 25.4
|
|
27
|
+
svglite::svglite(paste0(filename, ".svg"), width = w, height = h)
|
|
28
|
+
print(plot)
|
|
29
|
+
dev.off()
|
|
30
|
+
grDevices::cairo_pdf(paste0(filename, ".pdf"), width = w, height = h, family = "Arial")
|
|
31
|
+
print(plot)
|
|
32
|
+
dev.off()
|
|
33
|
+
ragg::agg_tiff(paste0(filename, ".tiff"), width = w, height = h, units = "in", res = dpi)
|
|
34
|
+
print(plot)
|
|
35
|
+
dev.off()
|
|
36
|
+
}
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
## Going deeper
|
|
40
|
+
|
|
41
|
+
- `references/r-workflow.md` — the R plotting workflow when the user provides R scripts, templates, or data.
|
|
42
|
+
- `references/r-template-index.md` — adapt a user-provided or private R template collection without exposing source paths.
|
|
43
|
+
- `references/design-theory.md` — typography, color theory, layout rationale, export policy (backend-agnostic).
|
|
44
|
+
- `references/nature-2026-observations.md` — real Nature page archetypes to match before choosing layout.
|
|
@@ -0,0 +1,306 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: markdown-report-writing
|
|
3
|
+
description: Guide AI agents to write beautifully formatted, well-illustrated Markdown reports with proper structure, diagrams, and compatibility across GitHub and Obsidian. Use this skill whenever the user asks you to write a report, project documentation, experiment report, README, technical document, or any long-form Markdown content. Also trigger when users mention Markdown formatting, Mermaid diagrams, report templates, or document publishing.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Markdown Report Writing
|
|
7
|
+
|
|
8
|
+
Provide expert guidance for writing professional, visually polished Markdown reports that render correctly on both GitHub and Obsidian.
|
|
9
|
+
|
|
10
|
+
## Core Philosophy: Three-Layer Writing Model
|
|
11
|
+
|
|
12
|
+
When writing any Markdown report, think in three layers:
|
|
13
|
+
|
|
14
|
+
1. **Content layer** — Use CommonMark / GFM + Obsidian shared syntax for all headings, paragraphs, lists, images, tables, code blocks, footnotes, task lists, math ($\LaTeX$), and Mermaid diagrams. This is your foundation.
|
|
15
|
+
2. **Enhancement layer** — Add renderer-specific features only when necessary: GitHub `<details>` folding, relative links; Obsidian `[[wikilink]]`, `![[embed]]`, Callout, `cssclasses`.
|
|
16
|
+
3. **Build layer** — For complex layouts, table of contents generation, site styling, and slide exports, delegate to Pandoc / Quarto / MkDocs / GitHub Pages.
|
|
17
|
+
|
|
18
|
+
This ensures your output is readable, portable, automatable, and version-controllable across all target environments.
|
|
19
|
+
|
|
20
|
+
## Writing Principles
|
|
21
|
+
|
|
22
|
+
Follow these rules for every report:
|
|
23
|
+
|
|
24
|
+
1. **Shared syntax first** — Build the body with syntax that works on both GitHub and Obsidian (headings, links, images, tables, code blocks, footnotes, task lists, Mermaid, math).
|
|
25
|
+
2. **Relative paths for all assets** — Place images, diagrams, and attachments in `assets/` and reference them with relative paths.
|
|
26
|
+
3. **Enhance per target** — After the core is solid, add renderer-specific enhancements:
|
|
27
|
+
- **GitHub**: relative links, section anchors, `<details>`, Mermaid
|
|
28
|
+
- **Obsidian**: wikilink, embed, callout, cssclasses
|
|
29
|
+
- **Web/PDF/Slides**: delegate to Pandoc / Quarto / MkDocs
|
|
30
|
+
4. **Don't nest Markdown in HTML** — GitHub strips custom HTML attributes; Obsidian won't parse Markdown inside HTML blocks. Use Markdown tables for side-by-side layouts instead of `<div>` flexboxes.
|
|
31
|
+
5. **Mermaid first for diagrams** — GitHub and Obsidian both render Mermaid natively. For complex UML, generate PlantUML SVG first, then embed.
|
|
32
|
+
6. **Every figure needs alt text and a caption** — Every code block must declare its language.
|
|
33
|
+
7. **Every long document must have**: executive summary, table of contents (or equivalent navigation), figures with captions, and a conclusion / next-steps section.
|
|
34
|
+
|
|
35
|
+
## Quality Checklist
|
|
36
|
+
|
|
37
|
+
After generating any report, verify:
|
|
38
|
+
|
|
39
|
+
- [ ] All code blocks have language identifiers
|
|
40
|
+
- [ ] All images have alt text and captions
|
|
41
|
+
- [ ] All links use relative paths (no absolute paths to local files)
|
|
42
|
+
- [ ] Table of contents is present (for documents with 3+ sections)
|
|
43
|
+
- [ ] Mermaid diagrams render correctly
|
|
44
|
+
- [ ] Footnotes are properly paired (marker + definition)
|
|
45
|
+
- [ ] No complex Markdown trapped inside HTML blocks
|
|
46
|
+
|
|
47
|
+
## Standard Document Skeleton
|
|
48
|
+
|
|
49
|
+
Start every report with this upgradeable structure:
|
|
50
|
+
|
|
51
|
+
```md
|
|
52
|
+
---
|
|
53
|
+
title: Project Name
|
|
54
|
+
author: Team / Agent Name
|
|
55
|
+
date: YYYY-MM-DD
|
|
56
|
+
tags: [tag1, tag2]
|
|
57
|
+
---
|
|
58
|
+
|
|
59
|
+
# Project Name
|
|
60
|
+
|
|
61
|
+
> One-line summary: what problem this solves and what the conclusion is.
|
|
62
|
+
|
|
63
|
+
## Executive Summary
|
|
64
|
+
|
|
65
|
+
3-6 sentences covering background, approach, results, and conclusions.
|
|
66
|
+
|
|
67
|
+
## Background
|
|
68
|
+
|
|
69
|
+
Problem statement, context, and boundaries.
|
|
70
|
+
|
|
71
|
+
## Methods / Approach
|
|
72
|
+
|
|
73
|
+
Solution design, workflow, data, experimental conditions.
|
|
74
|
+
|
|
75
|
+
## Results
|
|
76
|
+
|
|
77
|
+
- Key finding A
|
|
78
|
+
- Key finding B
|
|
79
|
+
- Key finding C
|
|
80
|
+
|
|
81
|
+
## Conclusion / Next Steps
|
|
82
|
+
|
|
83
|
+
## Appendix & References
|
|
84
|
+
|
|
85
|
+
- [Raw data](./data/raw.csv)
|
|
86
|
+
- [Diagrams](./assets/fig-overview.svg)
|
|
87
|
+
- [Supplementary docs](./docs/appendix.md)
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
## Layout & Typesetting Techniques
|
|
91
|
+
|
|
92
|
+
### Images and Figures
|
|
93
|
+
|
|
94
|
+
Always provide alt text. Use SVG for diagrams, PNG/WebP for screenshots:
|
|
95
|
+
|
|
96
|
+
```md
|
|
97
|
+

|
|
98
|
+
*Figure: Overall system architecture.*
|
|
99
|
+
|
|
100
|
+
[View full-size SVG](./assets/fig-system-architecture.svg)
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
### Side-by-Side Layout (Cross-Platform Safe)
|
|
104
|
+
|
|
105
|
+
Use **two-column Markdown tables** as your grid system — this is the only approach that works reliably on both GitHub and Obsidian:
|
|
106
|
+
|
|
107
|
+
```md
|
|
108
|
+
| Overview | Key Points |
|
|
109
|
+
|---|---|
|
|
110
|
+
|  | - 4 modules<br>- 12 interfaces<br>- Risk: data sync |
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
Avoid `<div style="display:flex">` — styles get stripped on GitHub and block Markdown parsing on Obsidian.
|
|
114
|
+
|
|
115
|
+
### Tables
|
|
116
|
+
|
|
117
|
+
Always use standard Markdown tables. Escape `|` inside cells with `\|`:
|
|
118
|
+
|
|
119
|
+
```md
|
|
120
|
+
| Metric | Value | Notes |
|
|
121
|
+
|:--|--:|:--|
|
|
122
|
+
| Accuracy | 92.4% | Main model |
|
|
123
|
+
| Link to doc | [Appendix](./docs/appendix.md) | See details |
|
|
124
|
+
```
|
|
125
|
+
|
|
126
|
+
### Code Blocks
|
|
127
|
+
|
|
128
|
+
Always declare the language for syntax highlighting:
|
|
129
|
+
|
|
130
|
+
```md
|
|
131
|
+
```python
|
|
132
|
+
def evaluate(x: float) -> float:
|
|
133
|
+
return x ** 2 + 1
|
|
134
|
+
```
|
|
135
|
+
```
|
|
136
|
+
|
|
137
|
+
### Mermaid Diagrams
|
|
138
|
+
|
|
139
|
+
Use fenced code blocks — both GitHub and Obsidian render them natively:
|
|
140
|
+
|
|
141
|
+
```md
|
|
142
|
+
```mermaid
|
|
143
|
+
flowchart LR
|
|
144
|
+
Data[Data Input] --> Clean[Cleaning]
|
|
145
|
+
Clean --> Analyze[Analysis]
|
|
146
|
+
Analyze --> Report[Report Output]
|
|
147
|
+
```
|
|
148
|
+
```
|
|
149
|
+
|
|
150
|
+
### Math Expressions
|
|
151
|
+
|
|
152
|
+
Both GitHub and Obsidian support $\LaTeX$ via MathJax:
|
|
153
|
+
|
|
154
|
+
```md
|
|
155
|
+
Inline: $E = mc^2$
|
|
156
|
+
|
|
157
|
+
Block:
|
|
158
|
+
$$
|
|
159
|
+
\operatorname{F1} = \frac{2PR}{P+R}
|
|
160
|
+
$$
|
|
161
|
+
```
|
|
162
|
+
|
|
163
|
+
### Task Lists and Collapsible Sections
|
|
164
|
+
|
|
165
|
+
```md
|
|
166
|
+
- [x] Requirements confirmed
|
|
167
|
+
- [x] Data collected
|
|
168
|
+
- [ ] Charts reviewed
|
|
169
|
+
- [ ] Document published
|
|
170
|
+
|
|
171
|
+
<details>
|
|
172
|
+
<summary>Click to expand technical details</summary>
|
|
173
|
+
|
|
174
|
+
Keep content here plain text or simple HTML.
|
|
175
|
+
Avoid complex Markdown (lists, tables, formulas) inside
|
|
176
|
+
if the target includes Obsidian.
|
|
177
|
+
|
|
178
|
+
</details>
|
|
179
|
+
```
|
|
180
|
+
|
|
181
|
+
### Footnotes
|
|
182
|
+
|
|
183
|
+
Use for citations, terminology, and data sources:
|
|
184
|
+
|
|
185
|
+
```md
|
|
186
|
+
There is a term that needs explanation[^term].
|
|
187
|
+
|
|
188
|
+
[^term]: This is where the explanation or citation goes.
|
|
189
|
+
```
|
|
190
|
+
|
|
191
|
+
## Report Templates
|
|
192
|
+
|
|
193
|
+
### 1. Project Report
|
|
194
|
+
|
|
195
|
+
Use when reporting project status, milestones, architecture decisions, risks, and next steps.
|
|
196
|
+
|
|
197
|
+
Required sections: Executive Summary → Background → Scope → Architecture & Design → Current Progress → Risks & Mitigation → Conclusion & Next Steps → Appendix.
|
|
198
|
+
|
|
199
|
+
Include: a system architecture diagram (Mermaid), a progress table with status per task, a risk matrix table, and a task checklist for next steps.
|
|
200
|
+
|
|
201
|
+
### 2. Experiment Report
|
|
202
|
+
|
|
203
|
+
Use when documenting experiments, A/B tests, benchmarks, or research findings.
|
|
204
|
+
|
|
205
|
+
Required sections: Executive Summary → Research Questions & Hypotheses → Experimental Setup → Variables → Procedure → Results → Discussion → Reproducibility → Conclusion.
|
|
206
|
+
|
|
207
|
+
Include: an environment/config table, a variables table (independent, dependent, controlled), a results comparison table, a results chart, and links to scripts/configs/raw data for reproducibility.
|
|
208
|
+
|
|
209
|
+
### 3. README
|
|
210
|
+
|
|
211
|
+
Use for repository introductions and project documentation.
|
|
212
|
+
|
|
213
|
+
Required sections: Project Name & tagline → Quick-start links → Description → Features → Project Structure → Quick Start (install, run, example) → Usage (with Mermaid flow) → Documentation links → Roadmap → Contributing → License.
|
|
214
|
+
|
|
215
|
+
See `references/templates.md` for full expanded templates with annotations.
|
|
216
|
+
|
|
217
|
+
## Choosing Tools for the Job
|
|
218
|
+
|
|
219
|
+
| Goal | Primary Tool | Agent Should Output |
|
|
220
|
+
|---|---|---|
|
|
221
|
+
| Repo README / project report | Pure GFM + Mermaid | `.md` + `assets/*.svg` |
|
|
222
|
+
| Experiment report / PDF export | Quarto | `.qmd` or enhanced `.md` → export HTML/PDF |
|
|
223
|
+
| Documentation site | MkDocs Material | `docs/` directory + nav config |
|
|
224
|
+
| Diagrams | Mermaid (first), PlantUML (UML) | `*.mmd` / `*.puml` source + rendered `*.svg` |
|
|
225
|
+
| Math rendering on web | MathJax | HTML site with math rendering layer |
|
|
226
|
+
| Local editing & export | Typora | Preview → export HTML/PDF |
|
|
227
|
+
| Slides / presentation | Quarto Revealjs or Pandoc | `.qmd` or `.md` → rendered slides |
|
|
228
|
+
|
|
229
|
+
### Rendering Commands
|
|
230
|
+
|
|
231
|
+
```bash
|
|
232
|
+
# Mermaid → SVG
|
|
233
|
+
mmdc -i diagrams/flow.mmd -o assets/flow.svg
|
|
234
|
+
|
|
235
|
+
# PlantUML → SVG
|
|
236
|
+
java -jar plantuml.jar --svg diagrams/architecture.puml
|
|
237
|
+
|
|
238
|
+
# Pandoc → HTML / PDF / Revealjs
|
|
239
|
+
pandoc report.md -o report.html
|
|
240
|
+
pandoc report.md -o report.pdf
|
|
241
|
+
pandoc -t revealjs -s slides.md -o slides.html
|
|
242
|
+
|
|
243
|
+
# Quarto → HTML / Website / Revealjs
|
|
244
|
+
quarto render report.qmd --to html
|
|
245
|
+
quarto render report.qmd --to pdf
|
|
246
|
+
quarto render slides.qmd --to revealjs
|
|
247
|
+
```
|
|
248
|
+
|
|
249
|
+
## File & Asset Management
|
|
250
|
+
|
|
251
|
+
Organize project files with this directory structure:
|
|
252
|
+
|
|
253
|
+
```text
|
|
254
|
+
project/
|
|
255
|
+
├── README.md
|
|
256
|
+
├── reports/
|
|
257
|
+
│ ├── project-report.md
|
|
258
|
+
│ └── experiment-report.md
|
|
259
|
+
├── docs/
|
|
260
|
+
│ ├── index.md
|
|
261
|
+
│ └── appendix.md
|
|
262
|
+
├── assets/
|
|
263
|
+
│ ├── figures/
|
|
264
|
+
│ │ ├── fig-system-architecture.svg
|
|
265
|
+
│ │ └── fig-results-comparison.svg
|
|
266
|
+
│ ├── screenshots/
|
|
267
|
+
│ │ └── screenshot-dashboard-home.png
|
|
268
|
+
│ └── generated/
|
|
269
|
+
│ ├── flow-overview.svg
|
|
270
|
+
│ └── gantt-plan.svg
|
|
271
|
+
├── diagrams/
|
|
272
|
+
│ ├── flow-overview.mmd
|
|
273
|
+
│ └── architecture.puml
|
|
274
|
+
├── data/
|
|
275
|
+
│ ├── raw/
|
|
276
|
+
│ └── processed/
|
|
277
|
+
└── .github/workflows/
|
|
278
|
+
└── docs-check.yml
|
|
279
|
+
```
|
|
280
|
+
|
|
281
|
+
**Naming conventions**: lowercase, hyphen-separated, semantic prefixes (`fig-` for figures, `tbl-` for tables, `exp-` for experiment data, `shot-` for screenshots, `flow-` for flowcharts). Keep both **source files** (`*.mmd`, `*.puml`) and **derived files** (`*.svg`) for version control and CI regeneration.
|
|
282
|
+
|
|
283
|
+
## CI Quality Pipeline
|
|
284
|
+
|
|
285
|
+
Include these 4 checks for long-lived documentation:
|
|
286
|
+
|
|
287
|
+
1. **Lint Markdown** — `markdownlint-cli2 "**/*.md"`
|
|
288
|
+
2. **Check TOC freshness** — `doctoc --dryrun .`
|
|
289
|
+
3. **Check links** — `lychee --verbose --no-progress "**/*.md"`
|
|
290
|
+
4. **Render diagrams** — `mmdc -i diagrams/*.mmd -o assets/generated/`
|
|
291
|
+
|
|
292
|
+
## Quick Reference: Per-Environment Differences
|
|
293
|
+
|
|
294
|
+
| Situation | GitHub Approach | Obsidian Approach |
|
|
295
|
+
|---|---|---|
|
|
296
|
+
| Internal links | Relative paths (auto-branch-aware) | `[[wikilink]]` or Markdown links |
|
|
297
|
+
| Embedding content | Standard `` | `![[file.svg\|700]]` |
|
|
298
|
+
| Collapsible sections | `<details><summary>` (safe) | Heading folding or Callout |
|
|
299
|
+
| Custom styling | Not available in repo `.md` | CSS Snippets + `cssclasses` frontmatter |
|
|
300
|
+
| Slides | Not native | `---` separated slides in note |
|
|
301
|
+
| Dynamic views | Not in repo `.md` | Dataview plugin queries |
|
|
302
|
+
|
|
303
|
+
## References
|
|
304
|
+
|
|
305
|
+
- `references/templates.md` — Full annotated templates for project reports, experiment reports, and README files
|
|
306
|
+
- `references/compatibility-matrix.md` — Detailed compatibility table for GitHub vs Obsidian features
|
|
@@ -0,0 +1,72 @@
|
|
|
1
|
+
# GitHub Markdown vs Obsidian Compatibility Matrix
|
|
2
|
+
|
|
3
|
+
This reference covers which features work on each platform and the recommended approach for cross-platform documents.
|
|
4
|
+
|
|
5
|
+
## Quick Decision Table
|
|
6
|
+
|
|
7
|
+
| Feature | GitHub | Obsidian | Cross-Platform Recommendation |
|
|
8
|
+
|---|---|---|---|
|
|
9
|
+
| Headings, lists, quotes, code blocks | Full | Full | Always use; the minimum shared subset |
|
|
10
|
+
| Internal links | Relative paths (branch-aware) | `[[wikilink]]`, Markdown links, heading/block refs | Use Markdown relative links for cross-platform; `[[wikilink]]` only for Obsidian-only notes |
|
|
11
|
+
| Images & SVG | PNG/JPG/GIF/SVG supported; SVG no scripts/animations | `.svg` + image embed supported | Diagrams → SVG; screenshots → PNG/WebP |
|
|
12
|
+
| Footnotes | Full | Full | Use for citations, terminology, data sources |
|
|
13
|
+
| Task lists | Clickable checkboxes | Native task lists | Use for TODOs, checklists, release checklists |
|
|
14
|
+
| Tables | Full | Full (escape `\|` in cells) | Use standard Markdown tables; no complex cell styling |
|
|
15
|
+
| Mermaid diagrams | Native rendering | Native support | Primary diagram language for agents; use fenced code blocks |
|
|
16
|
+
| Math ($\LaTeX$) | MathJax-based | MathJax-based | Safe to use both inline and block formulas |
|
|
17
|
+
| Collapsible content | `<details><summary>` works | HTML supported but Markdown won't parse inside HTML | GitHub: use `<details>`; Obsidian: use heading folding or Callout |
|
|
18
|
+
| Raw HTML | Supported but aggressively sanitized (no `script`, inline `style`, `class`, `id`) | Supported but sanitized; Markdown not parsed inside HTML | Only for minimal structural patches; never for complex layouts |
|
|
19
|
+
| Custom CSS | Not available in repo `.md` pages | CSS Snippets + `cssclasses` frontmatter | GitHub = content source; Obsidian/HTML site = style layer |
|
|
20
|
+
| Slides/presentation | Not native in repo `.md` | Obsidian Slides (`---` page separators) | Export via Quarto Revealjs, Pandoc, or Obsidian Slides |
|
|
21
|
+
| Dynamic views | Not in repo `.md` | Dataview plugin queries | Obsidian vault enhancement only |
|
|
22
|
+
|
|
23
|
+
## Key Compatibility Rules
|
|
24
|
+
|
|
25
|
+
### 1. HTML Sanitization
|
|
26
|
+
|
|
27
|
+
**GitHub** strips: `script`, inline `style`, `class`, `id`, and other potentially abusable attributes from HTML in Markdown.
|
|
28
|
+
|
|
29
|
+
**Obsidian** sanitizes HTML AND does not continue parsing Markdown inside HTML elements.
|
|
30
|
+
|
|
31
|
+
**Result**: Never put complex Markdown (lists, tables, code blocks, math) inside HTML containers. Use native Markdown constructs instead.
|
|
32
|
+
|
|
33
|
+
### 2. Side-by-Side Layout
|
|
34
|
+
|
|
35
|
+
**Do NOT use**:
|
|
36
|
+
```html
|
|
37
|
+
<div style="display:flex">
|
|
38
|
+
<div></div>
|
|
39
|
+
<div>Some text</div>
|
|
40
|
+
</div>
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
**Use instead** (cross-platform safe):
|
|
44
|
+
```md
|
|
45
|
+
| Diagram | Description |
|
|
46
|
+
|---|---|
|
|
47
|
+
|  | - Point 1<br>- Point 2 |
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
### 3. Collapsible Sections
|
|
51
|
+
|
|
52
|
+
**GitHub**: `<details><summary>Title</summary>...content...</details>` works well.
|
|
53
|
+
|
|
54
|
+
**Obsidian**: HTML is supported but Markdown inside won't parse. Use Callout blocks or heading-based folding instead.
|
|
55
|
+
|
|
56
|
+
**Cross-platform**: If you must use `<details>`, keep the content as plain text or simple HTML. Avoid nesting Markdown lists, tables, or code blocks inside.
|
|
57
|
+
|
|
58
|
+
### 4. Links Strategy
|
|
59
|
+
|
|
60
|
+
- Cross-platform text: Use **Markdown relative links** `[text](./path/file.md)`
|
|
61
|
+
- Obsidian-only: Use `[[wikilink]]` and `![[embed]]`
|
|
62
|
+
- GitHub: Relative links auto-adapt to the current branch
|
|
63
|
+
|
|
64
|
+
### 5. Styling Strategy
|
|
65
|
+
|
|
66
|
+
- GitHub repo `.md`: cannot inject custom CSS
|
|
67
|
+
- Obsidian: use CSS Snippets (`.obsidian/snippets/`) + `cssclasses` frontmatter
|
|
68
|
+
- Exported HTML/sites: add CSS at the site level (Pandoc, Quarto, MkDocs)
|
|
69
|
+
|
|
70
|
+
## Bottom Line
|
|
71
|
+
|
|
72
|
+
When in doubt, use **pure CommonMark/GFM syntax** (headings, links, images, tables, code blocks, footnotes, task lists, Mermaid, math). It renders correctly on both platforms and migrates cleanly to any export format.
|